Commonsensical Documentation

Nonfiction, Science & Nature, Technology, Technical Writing, Computers
Cover of the book Commonsensical Documentation by Deena Chadwick, Deena Chadwick
View on Amazon View on AbeBooks View on Kobo View on B.Depository View on eBay View on Walmart
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.

View on Amazon View on AbeBooks View on Kobo View on B.Depository View on eBay View on Walmart

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.

More books from Computers

Cover of the book Building Websites with TYPO3 by Deena Chadwick
Cover of the book Microsoft SharePoint Foundation 2010 Step by Step by Deena Chadwick
Cover of the book Adaptation, Resistance and Access to Instructional Technologies by Deena Chadwick
Cover of the book Apple Training Series by Deena Chadwick
Cover of the book BLOGGING BOUNTY by Deena Chadwick
Cover of the book Recent Advances in Computational Optimization by Deena Chadwick
Cover of the book Emerging Technologies and Applications for Cloud-Based Gaming by Deena Chadwick
Cover of the book How I Make Over $1,000 a Month Writing About Stocks Online by Deena Chadwick
Cover of the book Design Theory by Deena Chadwick
Cover of the book Predictive Analytics Using Oracle Data Miner by Deena Chadwick
Cover of the book Dark Pools by Deena Chadwick
Cover of the book Hacks for PUBG Players Advanced Strategies: An Unofficial Gamer's Guide by Deena Chadwick
Cover of the book Funktionale Sicherheit nach ISO 26262 by Deena Chadwick
Cover of the book Snort Cookbook by Deena Chadwick
Cover of the book Virtualisierung. Theorie und Praxis am Beispiel der Servervirtualisierung by Deena Chadwick
We use our own "cookies" and third party cookies to improve services and to see statistical information. By using this website, you agree to our Privacy Policy