DEV Community

Cover image for Guide to writing a classic technical document
Sundaresan Anandan
Sundaresan Anandan

Posted on

Guide to writing a classic technical document

Recently I read some articles πŸ“° about how organizations are converting boring and dull technical documents 😴 into classic ones πŸ€‘.

Here are my takeaways:

1) Identify your right set of audience 🎯: Think you designed some amazing fashion clothes that look stunning, but you put those advertisements in some restaurants, so you’re trying to reach the wrong set of audience. So always identify your audience and carefully craft a document.

2) If possible, utilize the data πŸ“Š: There are some applications which can provide numerous numbers of analytical data amounts, like how long the reader reads the document and where exactly he stopped scrolling. Using those data points, identify the interesting part of the document which your audience likes the most.

3) Write simple and clear πŸ“œ: Try to avoid the use of complex words which are hard to understand by users. Use the standard word format like Time, New Roman, Calibri and avoid the zombie word format.

4) Get it reviewed βœ…: Many articles forget to do this step. As creators of the document, we tend to imagine our article is well crafted and prone to mistakes. So, in reality, there can be something which we are not aware of. So, get that reviewed by some team members.

Let me know your thoughts about this article πŸ€”

Thanks for Reading πŸ˜€

Top comments (0)