Basic Questions That Every (Technical) Writer Should Try To Answer - AKA Technical Writing 101:
I assure you that If you can answer all of these questions, your readers won't mistake you for a chatbot :)
1. What is the purpose of the document that I'm writing?
2. Why am I writing this document?
3. Who is the target audience of this document?
4. Is this document part of a series of documents?
5. If so, have I established a nexus to the other documents in the series?
6. Are there any predefined formal requirements that the document must meet?
7. Does the document meet those requirements?
8. Does the document include an introduction?
9. Does the introduction clearly explain the purpose of the document to the target audience?
10. Does the introduction present the topics that will be explored in the body of the document in a straightforward way?
11. Does the document include a conclusion?
12. Does the conclusion provide a good summary of the previously explored topics?
13. Does the conclusion tell readers what they should have learned by following the document?
14. Does the body of the document include use case scenarios based on user personas that explain the potential advantages of adopting the explored tools or methods?
15. Does the body of the document depict real-life examples of how readers can immediately start using the tools or methods explained in the document?
#TechnicalWriting #TechnicalCommunication #Writing #Nonfiction #Documentation #Docs
