It’s not the questions you ask that matters, it’s the way you ask them. Technical writers, business analysts, and developers all ask questions. They want answers. And some are better than others. Some ask many times to get the definitive answers. Others think they have the answer but, on closer inspection, have overlooked some vital […]
The length of the topic title, i.e. the number of characters, needs to be considered when creating topics for online help. Let’s say you’re creating different topics in RoboHelp. Procedures, reference, and conceptual materials. Each of these needs an intuitive and meaningful name. That makes sense. However, you also need to consider the length of the topic […]
Recently, we looked at how to determine the quality of your technical documentation. We suggested an approach where you: Identify the scope Identify quality criteria Review a sample of documents Create a baseline Expand the scope All this makes sense. However, we also need to look at how to define a fair scoring system. Why? […]
One of the difficulties in managing a large team of writers is determining the quality of their work. This is more difficult if the teams work in remote offices, for example, in different countries, and you want to get a better understanding of where they are succeeding and falling short. One way to get some […]