Anatomy of a Document

When there are no existing documents, we start from the ground up and formulate a baseline for creation.
These are the basic steps:

• Requirements Definition:
  Determine the type of documentation required and the best style and format. Depending on the type of document:
  • Policy and Procedure
  • 'How To' Manual
  • Functional Specification
  • Technical Specification
  • User Guide
  • Program Specification
  • System Specification
  • White Paper
    


• Data Gathering:
  Conduct interviews of SMEs where necessary and compile operational notes. Organize and create a working text for review.
  For an illustrated example of our documentation approach, see Crafting a Document
  


• Illustration and diagrams:
  Complex concepts and system depictions can be visually narrated with the use of such tools as:
  • Visio
  • Adobe Illustrator
  • Adobe Photoshop
  • Macromedia Fireworks
  • Powerpoint


• Review Process:
  Use electronic routing to facilitate the review and feedback of all concerned parties.
  
• Sign-off