{"id":6710,"date":"2022-09-02T15:12:16","date_gmt":"2022-09-02T09:42:16","guid":{"rendered":"https:\/\/razorpay.com\/learn\/?p=6710"},"modified":"2024-09-11T12:44:40","modified_gmt":"2024-09-11T07:14:40","slug":"writing-tech-documentation-do-your-research","status":"publish","type":"post","link":"https:\/\/razorpay.com\/learn\/writing-tech-documentation-do-your-research\/","title":{"rendered":"Writing Tech Documentation? Do Your Research!"},"content":{"rendered":"

Technical documentation is an essential tool for any software company. Why? Companies rely heavily on documentation to educate their customers and reduce support tickets. Take the example of Razorpay Docs. In the last 90 days, over 1.8 million users (source: Google Analytics) visited our documentation to find answers to their questions!<\/span><\/p>\n

Given its importance, Tech Writers at Razorpay take the utmost care to create and publish accurate and complete documentation. And all of this is possible thanks to our in-depth research and analysis process.<\/span><\/p>\n

One of the biggest mistakes any writer can make is not putting in enough effort while researching content – be it for a blog or a technical document. After all, what is the point of writing if one is unsure of the content\u2019s accuracy and completeness? Therefore, research and analysis is the first step of the document development life cycle.<\/span><\/p>\n

\"...\"<\/p>\n

An Ideal Research Process<\/span><\/h2>\n

As per the Document Development Life Cycle, the tech writer should conduct in-depth research before beginning to write. Given below are some of the best practices that can be followed by writers in the pre-writing, drafting, and post-writing phases:<\/span><\/p>\n

Pre-writing Phase<\/span><\/h3>\n