Posted by: archdave | June 12, 2009

Great Documentation: 10 Tips

For more detail click the link.

1. Short Sentences – to ensure that your reader is following you.

2. Consistent Terms – spell out acronyms or technical expressions at the outset

3. Clear Screen Shots – nicely selected screen shots

4. Relevant Diagrams – nice diagrams also will help the reader to understand your points

5. Know Your Reader – the ones reading technical documentation about software are developers and quality assurance personnel

6. Give Examples – use relevant data and models

7. Short Paragraphs – do not cover more than one important concept per paragraph

8. Detailed Table of Contents – take the time to provide a nice document map in the form of a good TOC

9. Detailed Index – have a nice index that covers, alphabetically, important concepts

10. Publishing Your Work – choose the output format that will be best for your audience



Categories