A brief guide to managing documentation projects for Project Managers will demonstrate that when done correctly will produce long-term benefits.
Here are some examples to help keep your documentation on track.
The original writer is not the best person to check their documentation because they very rarely spot their mistakes.
- Arrange for a peer review and/or technical review of all changes
- establish a review process to make sure the documentation is both factually correct and consistent.
All documentation requires ongoing review once or twice a year.
- If your company use a Document Management system to store documentation, make use of the “metadata” windows to describe the content changes to make the review process easier and consistent.
- If you are so inclined adding an index to your document, especially when it is a large document will enhance the documents usability
Like everything else, documents become living information that:
- Maintaining the documentation represents a significant challenge
- Without a management policy or agreed procedure, the Documentation you are creating will cease to have any value if it is not updated
- Documentation requires dedicated resources, in which some companies will not invest
- In other words, use or contract an experienced Technical Writer