Writing user manual or help for analytical tools, in support of science research is always a challenge for writers, not only for its technical accuracy but also in terms of knowledge transfer. This involves good amount of knowledge percolation, and precision in language before it goes for the technical correction.
Some of the custom research analytical tools consist of numerous algorithms for computing the data to suit the requirement of the analysis. Evidently these tools are meant for highly knowledgeable audience who would like to use these tools in pursuit of achieving unknown facts. The analyzed data may be used to make hypothesis in the area of research or made it public for some other to validate, make relation and further predictions.
The basic aims of user guide or help is to lead user to familiarize different functionality and features of the tools to achieve desired result. However, when the analytical tool is a niche product, the job of a technical writer becomes tough. The confusion begins when technical writers do not know the knowledge level of the audience. Even when they know, it is sometimes misleading. For example, if you consider that all the analytical scientists and researchers have computation algorithm knowledge then it might not hold true to the whole class. Most of the time, it may incidentally become true that audience for whom you are writing user manual finds it useful and have no doubts performing the tasks they desired to do.
But most of the times it will not be so, some of them in spite of knowing and able to perform the tasks will come back to you to verify that how they are doing is the right way. Some of them will come back to you seeking knowledge looking beyond the beauty. Some will have comparative tastes to analyze the results derived differently with different tools. These audiences will seek detail knowledge of the logic and algorithm. Sometimes they will have a quest to know the comparative analysis of the similar tools available in the open market. The fact is, scientist and researchers like to verify and validate before they accepts anything. That’s how the science evolves.
These are too many things to do. The question is: can your user manual or help answer all these questions? Ideally it should not, but looking at another perspective it can carry as much knowledge as possible. But, how much, is yet again a question. Nevertheless, even if you have mega size manual, there will still be some message for you.
However, saying so, involves great amount of energy to compile the required content into the user manual. This is the primary job of a technical writer but it requires evidently all the stakeholder to contribute in to making of the manual. It is like sewing the cloths with fine needles.
Task looks Herculean, but it helps audience a lot in case of developing a tool in cutting edge technology. That is the primary goal of a user manual. Never to forget, one satisfied user can bring you ten more other users for your product.
