A user-friendly documentation is a winning documentation for any technical writer. But creating one can be tricky, especially if you’re writing for a diverse audience that cuts across locations and languages. Here are great technical writing principles that can guide you whenever you’re looking to write user-friendly help materials.
Help Authoring Tools
An effective software documentation helps the end users working with the software understand its features, functions, and how to perform specific tasks. For technical writers, the question is, how exactly can you achieve all these while writing for end users with very little or no technical knowledge? Let’s find out!
Would you love your website to look great with a stunning and richer user experience across all devices, platforms, and screen sizes?
It’s easy to conclude that you need such a website because of smartphones and tablets users. Period. But you should look beyond the current devices and imagine future devices such as smartwatches, Google glass, virtual and augmented reality, or any other new devices tech experts may throw at us. Responsive websites and development will work for them too. Let’s see how important responsive HTML websites are.
You’ve designed a near perfect product or built a great software. And then you hired some of the best technical writers to write a user-friendly help manual to solve usability problems. You want your product users to start enjoying the product from the first minute. The technical writers did a great a job, and your user experience team confirmed that.
But after launching your product or releasing an update, you seem to be spending a lot more on customer support. In many cases, the answers users are looking for are right inside the user manual. So now you’re asking the same question many manufacturers and developers have been asking. Do product users ever read help manuals?
Picking the right format to publish your help files can be tricky, especially if you’re creating your first help manual and you want to avoid the biggest mistakes first time help manual authors make. The right format determines if your users have access to your help files exactly how and when they need it.
If you’re using a help authoring tool (and you should because they make it easier to write better help documents in half the time), publishing in multiple formats should be no trouble at all.
The big question we’re answering today is, should you publish a print manual (hard copy), or a screen manual (PDF, CHM, Web based HTML, eBook format...).
What’s the worst mistake you can make as a first time help manual author?
A good help manual is user-friendly, and contains clear instructions that users can find and use easily. But if you’re a first time help manual author, creating a good one can be a tough task, especially if it’s your first technical writing project.
Interestingly, every great help manual writer had their first moment too, and made several mistakes on their first attempt. We’ve compiled these mistakes, so you wouldn’t repeat any of them. Thankfully, you can learn from these mistakes and create a top-notch help manual on your first attempt.
Let's face it, help documentation today has a terrible image. Almost everyone you talk to about it has a bad impression of help manuals. There are lots of different reasons for this, some of the most common are:
- It doesn't answer the questions you have
- You can't find the answer even though you know it's in there somewhere
- The manual is hard to navigate
- The documentation is out of date
- The documentation doesn't exist yet
Many authors of help manuals have discovered that help authoring tools or HAT software programs are a great way to quickly and easily write manuals, and other help documents. Not so many people stop and think about the way using HAT software programs actually benefits everyone else, including the product manufacturer paying for the manual, and the end user of the product.
Microsoft Word is a great piece of software. It allows users to quickly and easily write anything from a school report to business letter. The biggest advantage which Microsoft Word has is user-familiarity, it is a software which most of us have grown up with using it both at school and in the office. For many people it is still the natural choice when they need to write anything in a business environment. And for most purposes Microsoft Word is ideal, but there are some applications including writing product documentation for which it is not so well suited.
There are many reasons why Microsoft Word is not the right tool to help you write product documentation, here are just five of them.
Almost everyone has at least one help related horror story to tell. Whether it is about trying to understand a product when the help manual has been written in such poor English that it is unintelligible, or a product that has shipped with a manual for entirely the wrong model. Perhaps the story is about one of those manuals that are packed so full of details that there is too much information and it becomes almost impossible to find the answer you need quickly. There are many ways that help manuals can go wrong but in general they can usually be broken down into two main areas...