For many years I’ve regarded Simplified Technical English as an outdated legacy from the Aerospace industry. But that opinion has changed radically in the last few weeks and I’m becoming a big fan.
As technical writers, the majority of our work is based on translating technical jargon, making complex tasks more easily understandable and forming knowledge bases for new and existing users. However, as user interfaces become more easy to navigate and the
The most important tool for a modern-day technical writer is the computer. Advances in computing power have allowed technical communicators across every industry to create and manage bigger, more complex and more visual projects, whether that is online help systems
Spam; love it or loathe it? This may seem like an odd question. Everybody hates spam don’t they?
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
Social media as we know it has blossomed from the early days of Friendster and Bebo to the ever-present Facebook and Twitter. It’s important for every technical writer to take advantage of tools that can help your output and productivity.
I have worked as a technical author for nearly four years and have had to climb a steep learning curve. Today I am going to share with you a few of the common problems that I have encountered along the
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
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
So, you have written the perfect help guide. You have addressed and held your audience with concise, relevant documentation written in Plain English. Now you must build an index to ensure that users can find the help they need.