Review of Structured Writing: Rhetoric and Process

Mark Baker has published a new book called Structured Writing: Rhetoric and Process. It is probably the most important book on technical communication since Anne Gentle’s Docs Like Code. In this post, we’ll look at what the book covers. We’ll also include quotations from Mark’s book and his website. About the book The book provides an overview… Read more »

Adobe announces Adobe Technical Communication Suite 2019

Adobe has announced the release of Adobe Technical Communication Suite (2019 release). The suite comprises FrameMaker, RoboHelp, Captivate, Acrobat Pro DC and Adobe Presenter. We’ve been involved in the preview programme, and we can say there have been quite a number of changes with this release. One of the biggest changes to FrameMaker and RoboHelp has been to… Read more »

Which type of platform is best for developer documentation?

At the Write The Docs event in London last night, Gergely Imreh presented Resin.io’s approach to customer-driven docs – documentation as self service support. Resin.io is a software company that provides Linux containers to the Internet of Things. It sees itself as a support-driven organisation, and so documentation is very important to them. The discussions at the… Read more »

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 »