On an API documentation course we ran for a client yesterday, we showed a number of developer documentation websites, including ones from Amazon, Dropbox, Google and Microsoft. One common theme the delegates noticed was these sites contained a in-page table of contents, or a set of related links, on the right hand set of the screen. You will… Read more »
Category: Technical Documentation
Towards content lakes
One of the trends in both data and content management is the move away from silos. In data management circles, there is a trend towards the collection and aggregation of customer data into “data lakes”. According to Margaret Rouse, a data lake is: A storage repository that holds a vast amount of raw data in its… Read more »
Creating documentation in a Continuous Integration/Continuous Delivery environment
Creating user documentation and online Help in a Continuous Integration/Continuous Delivery environment can be challenging for technical communicators and developers.
How to create online Help topics that are editable by clients
In the Agile Technical Writers forum on LinkedIn, one of its members posted this question: “I need to create an contextual online help for an complex web tool (ok, that´s not that hard). The customer must be able to add some specific job instructions to this online help by himself. The customer part must not be overridden when the… Read more »
How technical documentation helps the customer journey
Here is a diagram that shows the different types of User Assistance that can help users as they progress through the customer journey: Supporting the user through the customer journey has become more important, partly because the subscription, “try before you buy”, sales model means users can stop being a paying customer at a moment’s notice. Today, all… Read more »
