Make Sure It's in There...
Make sure that your documents contain all the information that your readers need. Most adult business readers skim. Your document needs to be navigatable, and readers need to be able to find information quickly.
Links
If there are links to an application or other documents, make sure that they are included and that they function. All of our document templates for user guides or test plans have links to the application and other reference documents. When you edit a document, make sure that the links are still valid.
Glossary
If you use a lot of acronyms or technical terms, a glossary is helpful. We have so many terms, that our technical writer has created a departmental glossary on an internal website.
Checklist or List of Owners
In our test plans, we always include a checklist of tasks and owners in the introductory section. Many of the tasks need to be completed in order or they have dependencies. We also include a milestones section so that all of the participants have a summary view of the testing phase.
Road Maps
Use headers, table of contents, captions for pictures and charts to help your reader. These help readers navigate through your document.
Executive Summary
All proposals or recommendations need an executive summary section with all of the key facts.
Searches
If your documents are stored in a searchable repository, make sure to provide enough metadata so that searches are meaningful.
Links
If there are links to an application or other documents, make sure that they are included and that they function. All of our document templates for user guides or test plans have links to the application and other reference documents. When you edit a document, make sure that the links are still valid.
Glossary
If you use a lot of acronyms or technical terms, a glossary is helpful. We have so many terms, that our technical writer has created a departmental glossary on an internal website.
Checklist or List of Owners
In our test plans, we always include a checklist of tasks and owners in the introductory section. Many of the tasks need to be completed in order or they have dependencies. We also include a milestones section so that all of the participants have a summary view of the testing phase.
Road Maps
Use headers, table of contents, captions for pictures and charts to help your reader. These help readers navigate through your document.
Executive Summary
All proposals or recommendations need an executive summary section with all of the key facts.
Searches
If your documents are stored in a searchable repository, make sure to provide enough metadata so that searches are meaningful.




Comments