|
Check your technical documentation
• Does each term (in different documents), a single meaning?
• If the language of technical documentation easy, useful and understandable?
• Are new words or abbreviations explained in the technical documentation?
• Are reduction rules of spelling (controlled language) used?
• Is formulated the text of the technical documentation consistent and structured?
• Is there a table of contents with the points of division?
• Is the structure of the technical documentation useful and logical?
• If the contents of the technical documentation up to date?
• Has created a glossary for technical documentation?
• Are the page numbers in the index up to date?
• If the divided technical documentation by appropriate register?
• Are formulated the headings informative?
• Are concise calls to action?
• Has met the proper sequence of calls to action?
• Is limited the length of the individual records in all technical documents?
• Is the text of the technical documentation easy to read?
• Are the chosen font sizes for all the characters meet the documentation standards?
• Use of highlighting the text in all documents consistent?
• Are the contents of images, icons and symbols supported for?
• Do you support same information by identical image elements?
• If colors are used functionally and consistent?
• Are hazards created by a clear principle?
• Was all the warnings in the technical documentation?
• Are the colors used for the security levels conforming to standards?
• If warned in the technical documentation from abuse?
• Can use the user using the documentation, all parts of the plant safe?
• Does the operation of the system a quick guide?
• Provides technical documentation, a telephone number for queries?
• What software was created, the technical documentation?
• Can the technical documentation with the software easily changed?
• Can the technical documentation with the software into other languages?
• Has been selected a suitable output medium (PDF, online help)?
|
