Cruising Clearly Through a Product or Process
Posted on September 8, 2016
Filed Under Communication, Technology, Uncategorized | Leave a Comment
Web users are becoming increasingly savvy about getting the most insight possible into products they’re considering buying and using. So clearly presented documentation, notes the easyDITA blog, is doubling in importance: As a guide to value as well as use.
“So, start thinking about documentation as a marketing and sales resource,” easyDITA urges, “Don’t hide it behind logins or limit access to actual customers. Feature links to it on your product pages and reference it in your marketing materials.”
Brilliant, providing the documentation is clearly and usefully prepared. Not that instructions for putting equipment to work need to read like a novel. But they should read like a purposely prepared, easy-to-use guide that you’re proud of.
“Work with your tech writers to develop a clear tone and voice, and conversational language style guides that won’t scare away a first time visitor doing their homework. Generally speaking, this change in tone from very technical to more plain language style has become the standard for technical writing.”
Gee! Technical writing that breezes right along providing obvious value! How about that!
“In the world of content management, easyDITA notes, “documentation teams have often been relegated to a poor relations role in many companies, resulting in understaffing, limited budgets, and backlogs of inaccurate or out-dated documentation.” How dumb, once it’s pointed out, often too late.
“Finally, give the docs team credit where credit is due – they should be direct contributors to the bottom line, not a cost center.” It’s amazing how useful work springs into prominence once actual value is pointed out! – Doug Bedell
Comments
Leave a Comment
If you would like to make a comment, please fill out the form below.
Recently
- Presentations With Forethought
- Technical Writing’s Lineage – Surely It’s Deeper than Digital
- At the Holidays, Twitting Amazon
- Successful Cookie Baking – From Mom, an Acknowledged Expert
- Slides for a Tech Writer’s Craft
- Digital or Not, Be Clear
- Being Watchful About Digital Designs…
- When Proposals Don’t Click, Keep Making Them Anyway
- Like a Good Gardener, Help an Enterprise Keep Itself Current
- We’re Leaders All, And Need to Think That Way
Categories
Archives
- January 2017
- December 2016
- November 2016
- October 2016
- September 2016
- August 2016
- July 2016
- June 2016
- May 2016
- April 2016
- March 2016
- February 2016
- January 2016
- December 2015
- November 2015
- October 2015
- September 2015
- August 2015
- July 2015
- June 2015
- May 2015
- April 2015
- March 2015
- February 2015
- January 2015
- December 2014
- November 2014
- October 2014
- March 2014
- February 2014
- January 2014
- December 2013
- November 2013
- October 2013
- September 2013
- August 2013
- July 2013
- June 2013
- May 2013
- April 2013
- March 2013
- February 2013
- January 2013
- December 2012
- November 2012
- October 2012
- September 2012
- August 2012
- July 2012
- June 2012
- May 2012
- April 2012
- March 2012
- February 2012
- January 2012
- December 2011
- November 2011
- October 2011
- September 2011
- August 2011
- July 2011
- June 2011
- May 2011
- April 2011
- March 2011
- February 2011
- January 2011
- December 2010
- November 2010
- October 2010
- September 2010
- August 2010
- July 2010
- June 2010
- May 2010
- April 2010
- March 2010
- February 2010
- January 2010
Blogroll