How to Review a Document
Documents can help you with a wealth of information but at the same time poor documentation can leave you wondering. There are some classic mistakes you find in (almost) every document. Here are some of the mistakes you should avoid while preparing a document (usually an official doc)
Steps
There would be some points highlighted using a superscript sometimes, and no explanation of the symbol (asterisk, numeral, letter) at the bottom of the page. Leaves the reader wondering !!
No glossary anywhere in the doc, for explaining technical terms and specific acronyms.
Team specific slogans/language used in the doc. Documents are generally created to help new people who have no experience with the project, and this doesn’t help them.
Hyperlinks to temporary locations. This doesn’t work after a while and creates confusion. Links should be given only to permanent Wiki/Sharepoint etc sites.
Third party website links given. For eg, some free software tool which the previous developer/tester found useful for the project. Ideally, these should be downloaded and kept in the Resource folder for the project, than giving out the link to everyone and triggering another hundred unnecessary downloads.
‘Assumptions’ section generally contains personal opinion of the author. It should contain those entries which are made in team meetings and decided upon by project management.
Comments
very helpful..
very helpful..
Post new comment