Latest posts by techwriter (see all)
- Test Your Knowledge of 4 Basic Fonts – Drag & Drop - January 27, 2017
- How NOT to Design a Web Site - January 25, 2017
- Hazards of Poorly Written Technical Documentation - December 26, 2016
The understanding of technical documentation is reliant on how informational the documentation is, and of how the person receiving the information perceives it to be. The directions must be clear and suitable for all levels of comprehension. The concept must relate triggers to users in forming clarity for usability.
Documentation writers focus on information about the product and incorporate the process involved in a professional display of skills. The skill level depends on the particular writer responsible for documenting a procedure, and what his comprehension is of the sources provided by the inventor may be. The writer selects tools based on his understanding in creating the document. This information passed onto the user, should enable the effective utilization of the product.
It would seem that the originator of criteria would be the best suited to explain the concept however this is just not the case. Most inventors devote total focus to their creation and it is second nature to them on how it works, and they in turn think that this knowledge should simply be evident to anyone.