Documentation refers to the written text that accompanies a certain product.
This usually includes instructions for usage, product specifications and descriptions, reference, tutorials and troubleshooting suggestions.
With software products, documentation can include code.
Documents are not known for being especially user-friendly and most of the time, they seem to be written by writers who weren't bothered with documentation usability tips.
A common complaint about document usability is that the reader has to hack their way through a dense jungle of technical jargon.
Documentation usability tips recommend that any writing should provide clarity, not confusion.
Most times, simple and consistent writing can turn out to be the clearest.
If something can be explained in one short passage, then do so.
Using three pages to explain one simple aspect of a product causes frustration and the reader to become disinterested.
In order to write a clear and concise document the reader will have no trouble understanding, the document writer has to know what the reader or user is like.
By having a grasp of the cultural and educational background of the reader, the writer should then be able to present the document in a manner that will be well-received.
Thinking like the user also allows the writer to foresee any potential problems, such as with first time usage, and provide the appropriate troubleshooting, tutorial and reference guides.
A well-structured paper is a key feature that most documentation usability tips point out.
A table of contents should be available to give the audience an organized overview of the entire document.
A glossary would also be much appreciated if there are technical terms or terms that are foreign to the user.
Formatting should also be consistent throughout the document.
It's very easy for document writers to pack documents with seemingly impenetrable jargon.
However, it is best if things are kept simple.