Could the way you think when creating technical communication be affecting your health? If you find it difficult to relax, are often anxious, and feel extremely risk averse, the answer could be YES. In this post, I’m going to look at how the thought processes we use in our work can become habits that lead to […]
This is Part 3 of a series of posts on how to create the following layout, complete with accordion menu and slide-in drill-down menu, in MadCap Flare.
If you missed the previous parts, see:
In Part 3, we’re mostly going to be looking at how to create the master page for this layout, but before […]
It’s not often that I recommend books to other technical communicators, but I’ve recently finished a book that I think many tech writers can learn from: The Art of Explanation by Lee LeFever. Now before you spit your tea out in amazement, let me just confirm that, yes, the book I am recommending isn’t about […]
“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 […]
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 […]
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 […]
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 an XML editor like […]
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 […]
Are you a technical writer who is struggling to interview SMEs? Are you frustrated that your work is seen as a necessary evil rather than something that adds value to the product? Then this ‘How to Interview SMEs’ article is for you.
What? You Don’t Even Know That?!!
Yes, I’ve had that said to me. On more […]