Users gravitate toward visuals
In my initial days of working as a technical writer, I was advised not to include screenshots of the proprietary software anywhere in documentation. The rationale was that the images could …
Month: December 2016
Documentation topics are interconnected
Making a request to one documentation topic often requires the technical writer to adjust other topics as well. Simple Example: When a new feature is added to a software product, there may …
Technical Writing Best Practices
“The fundamental purpose of scientific discourse is not the mere presentation of information and thought but rather its actual communication. It does not matter how pleased an author might be …
Leveraging sub-domains
Websites and Portals are getting bigger. Content is all over the place. As a result, it is not always possible to fit into one we template or content management system. …