Sunday , 23 November 2014

Category Archives: Blog

“Technical Writing’s Dead, Get into E-Learning”

“I can’t believe you are still doing that. Technical writing’s dead, get into e-learning.” Not my words, but the words of a former technical writer who moved on to work in information design. Usually, comments like this are like water off a duck’s back, but this time something jarred with me. So I decided to ask some learning professionals about… Read More »

Technical Writing Tools – Do You Need to Know Every Tool?

Have you ever felt yourself becoming overwhelmed with the amount of things you need to learn? Join the club. Since quitting the day job as an employed technical writer and trying my hand at contracting, I’ve been compelled to learn more about a variety of Help Authoring Tools and technical communication principles, ideas, etc.  Like an idiot, I’ve tried to… Read More »

A Process for Technical Documentation

When you’ve been a technical author for many years, the process of creating technical communication becomes second-nature. So when a client asked me to draw up a technical communication process, I had to think carefully about each step of the process. Of course, it can vary depending on the organisation, but on the whole, the process I work to is… Read More »

5 Key Benefits of Topic-Based Documentation

Taking a topic-based approach to your documentation can improve the quality of your manuals and online help, reduce your documentation costs, and make it easier for your writers to produce and update content. This approach is not new, but implementing it with the latest authoring tools, such as Flare, Robohelp, Confluence or a DITA editor like oXygen, does give you… Read More »

What is Topic-Based Documentation and How do you Write it?

Topic-based documentation

Topic-based documentation is a way of writing documentation in stand-alone chunks, which are usually stored in separate files (or topics). Each topic focuses on one specific subject, and this applies to pretty much any type of user documentation. To illustrate the point, I’ll avoid the obvious software example and go for something more unusual…let’s say you are writing a manual… Read More »

Technical Writing Advice, Software Tips, and Opinions

mewavingsmall

Welcome to the StrayGoat Technical Communication Blog. Here, I’ll be posting technical writing advice, opinion pieces, recommendations, and explanations on how to achieve various tasks with different software tools. (The latter of which is going to be a reminder for me as much as anyone else!). If you find the technical writing advice posts useful, please leave a comment. Read More »