Well written documentation requires skill and experience. 

Home | Who Am I? | Sounds Familiar | Writing Sense | Disaster Recovery | Approaching a Project | Projects | Contact Me

Email Me

Mob: 07984 306656

Mob: 07534 222517

Approaching a Documentation Project

When I approach a new project I need to establish four criteria to get the project on track and working in a positive direction.

1. Define the type of documentation to be written
2. Design the templates with appropriate formats and branding
3. Implement the writing and review process
4. Review and evaluate the results.

1.      Project Definition begin by defining the tasks, and deliverables.

• The level of detail to include in the document

• How much technical detail will the document contain

• Will the document be translated into other languages?

• Establish the audience for the documentation

• Does the documentation fulfil a legal requirement?

• How many SMEs will be involved

• How will we store and manage the flow and review of documentation?

2.      Design: Create the templates with heading and styles, including bullet and numbered lists. Use one Font to ensure consistency  

3.    Implementation: Explain the responsibilities of Subject Matter Experts (and other sources) and review meetings and future meeting to establish that the documentation is on track.

4.    Review and Evaluate: Your technical documentation project will be evaluated by SMEs to determine that the goals of the project were met

Make sense of your documentation 

• Who Am I? • Sounds Familiar • Writing Sense • Disaster Recovery • Approaching a Project • Projects • Contact Me •