The name technical writer suggests about a person who writes the technical documents for the user, which helps them using the product. More often than not, when the user struggles to find out the answers of their problem in using the product, they seek the help from the support group. Obviously, users don’t find the answer of their problems in the documents, which were shipped to them along with the product.
The standard procedure followed to analyse the user’s problem and leading them to learn the product to use are not based on the realistic approach. Neither feedback system revamps the standard procedure in the next revision of the documents. The revision only includes the recent addition in the features and functionality. But most of the time even users also do not like to send their feedback on the documents. May be because of the perceived idea that their feedback will not be taken care or the life cycle of the product is so short that they understand that revamps are not possible.
In any case, it does not help documentation to improve. Therefore, sometimes technical writers, who are to be blamed for the sub-standard documentation, finds even user responsible for this cause. In a normal scenario, a technical writer assumes to be a user and interprets the knowledge transfer in a best suitable way they can. But, that may not be the simple way of translating the knowledge what user would have liked to be. I really bet, the understanding level and approach of different users differ immensely. That is how, even the understanding and use of an authoring tool widely differs among the technical writers too. Some are easily able to use the tool, whereas some takes time to learn and use.
I can understand that each one of us has different learning curves and that reflects while even using an authoring tool. Nevertheless, when a technical writer struggles to learn the tool using the Help or the User manual and finds it tough to get their answers, even then they would not like to send the feedback to the corresponding writers group. If they do so, hopefully, it might help improve adding those points in the next version of the product that could help another writer avoid rigors of tough learning.
Ideally, it could be better to list down the questions, which could be included in the User Manual or in the Help and send across to the product company as feedback. And I suppose during the next version as an update even these new answers could feature into the document. Therefore, as a user, it’s a best way to help our fellow writers and help improve even the documentation on the community level. Otherwise, we will continue writing the documents as we usually do and get overwhelmed thinking that we have produced the best. But, in reality, we will not be serving the user, for which we are paid for. Its time we don the role of a writer when we are writing the manual and take the role of a user when we use a product. At the end of the day we should not forget to send and receive feedback which would lead us to help and get help on our documents.
