Andrew Etter has written a short, Kindle ebook called “Modern Technical Writing: An Introduction to Software Documentation“. The book is Andrew’s personal view of technical communication, based on his experience of being a technical communicator in Silicon Valley. It neatly describes the “Docs-like-code” approach to technical writing, and it challenges the impulse to write about everything…. Read more »
Tag: review
How do you measure the effectiveness of operations manuals and other procedures documents?
When reviewing an organisation’s procedures documents, there are a number of key factors we look at. These relate to the value of the document itself, how it is structured and the clarity of the content (i.e. the words and sentences). One way to rate these factors is by a simple red, amber, green traffic light… Read more »
Book review: Confluence, Tech Comm, Chocolate
I was sent a review copy of Confluence, Tech Comm, Chocolate: A wiki as platform extraordinaire for technical communication, by Sarah Maddox. It’s about using wiki technology for developing and publishing technical documentation, using the Confluence platform, the emerging trends in the creation of User Assistance and, in places, chocolate. The book is aimed at three… Read more »
Book review:”The Content Pool”
I was sent a review copy of Alan J. Porter’s latest book, The Content Pool: Leveraging your company’s largest hidden asset. It’s a well written book that’s ideal for anyone who is uncomfortable about the way their organisation creates and manages its written content, as well as anyone who simply wants to manage their content in… Read more »