Documentation should be concise, consistent, and simple

Posted by bob on Mar 1, 2016 7:59 AM EDT
Opensource.com
Mail this story
Print this story

"Words mean things" is one of my favorite expressions. I often use it in jest, but it's an important consideration when writing documentation. I'm normally one to sling words around with great artistic flair, but when it comes to writing technical documentation, I've become more deliberate in my wording. I don't know when this habit started, but I've noticed over the years that I have grown increasingly careful in how I use words. This article introduces three considerations and accompanying resources that you can keep in mind as you write. read more

Full Story

  Nav
» Read more about: Story Type: News Story

« Return to the newswire homepage

This topic does not have any threads posted yet!

You cannot post until you login.