Six online help tips
This article gives tips for online help that goes beyond the critical writing skills. It considers issues such as user contribution, interaction, responsive design and software integration.
Help systems and user guides are inevitably boring. Discuss.
Recently, I’ve been considering my style of writing style. One of the things most of us are taught when we first become technical authors is that a user/reader shouldn’t be able to tell which technical author wrote the help or
Case Study: Online Help using RoboHelp
At Armada we are very proud of our success rate in winning new business. Read our case study on a client requiring an online help solution.
Spam, user guides and the use of language
Spam; love it or loathe it? This may seem like an odd question. Everybody hates spam don’t they?
A shortcut to technical writing success
As a busy technical writer, I like to work efficiently. This means optimising the use of my keyboard and mouse, for example by using keyboard shortcuts and right-clicks. I find it a little odd that I can remember so many
Case study – single source user assistance
Our client, Staffcare, developed a flexible software solution (also called Staffcare) for managing organisation’s HR, benefits and payroll data. Armada was commissioned to create a full user documentation set for System Administrators comprised of two formats: web-enabled online help PDF user
Improving the searchability of your documentation
A huge part of what makes a technical writer’s documentation successful isn’t just that it is easy to read, but that it is also easy to search and find the information that you are looking for. Searchability nowadays isn’t just
Accessibility of documentation
The intention of a technical writer is usually to inform, guide, instruct or perhaps persuade your audience. This requires that the documents you produce are easy to read and interpret by all those who need access to them. They must have
5 free tools for technical writing
Sometimes, it seems like being involved in technical writing is like acting as a circus performer. Ok, so we don’t have to walk across any tightropes or perform any acrobatics, but we often have to juggle many roles at the
Technical writing – science or art?
It’s a question we hear sporadically here at Armada on the Technical Writing, RoboHelp, FrameMaker and Flare training courses we run – do we class the profession we’re in as science or art? Are technical authors scientists or artists? Some people