| Author: | Deena Chadwick | ISBN: | 9781301241682 |
| Publisher: | Deena Chadwick | Publication: | April 12, 2013 |
| Imprint: | Smashwords Edition | Language: | English |
| Author: | Deena Chadwick |
| ISBN: | 9781301241682 |
| Publisher: | Deena Chadwick |
| Publication: | April 12, 2013 |
| Imprint: | Smashwords Edition |
| Language: | English |
Commonsensical Documentation is a guide to simple, lean, and agile technical writing. When you ask people what they expect when they read technical documents, many will probably tell you: long, boring, and hard to understand.
This can lead to disastrous outcomes:
• No one reads it – because it is too boring or long
• No one can understand it – it has too much jargon or technical terms
• Does not provide enough information – it is unclear or vague, assumes reader has more knowledge than they do
• Inaccurate – it is incomplete, is misleading, flat-out wrong, or not kept up-to-date
In today’s world of economic crisis, we have all become more cost focused, whether we like it or not. It is common to see stakeholders and clients reduce budgets and insist on faster turnaround times. Unfortunately when looking for ways to do this, documentation is one of the first things cut. Any documentation that is not desirable is considered to be of no value or a waste of time.
This eBook is about blending the best practices of communication and technical writing with a little common sense. By combining these principles technical writers and business analysts can produce documentation that will be valuable and appreciated.
Commonsensical Documentation is a guide to simple, lean, and agile technical writing. When you ask people what they expect when they read technical documents, many will probably tell you: long, boring, and hard to understand.
This can lead to disastrous outcomes:
• No one reads it – because it is too boring or long
• No one can understand it – it has too much jargon or technical terms
• Does not provide enough information – it is unclear or vague, assumes reader has more knowledge than they do
• Inaccurate – it is incomplete, is misleading, flat-out wrong, or not kept up-to-date
In today’s world of economic crisis, we have all become more cost focused, whether we like it or not. It is common to see stakeholders and clients reduce budgets and insist on faster turnaround times. Unfortunately when looking for ways to do this, documentation is one of the first things cut. Any documentation that is not desirable is considered to be of no value or a waste of time.
This eBook is about blending the best practices of communication and technical writing with a little common sense. By combining these principles technical writers and business analysts can produce documentation that will be valuable and appreciated.
