Writing effective documents is a crucial skill that is often underestimated. It allows us to communicate with individuals who may be in a different time zone or unable to attend a meeting. Well-written documents can also have a lasting impact. For example, a clear error message can save an engineer a significant amount of time. To create effective documents, it’s important to consider your audience, provide clear headings, and include important information such as dates and the names of the authors. Avoid assumptions, be specific, and use data instead of ambiguous language. Additionally, edit your documents for clarity and correctness, and take the time to read and provide feedback on others’ work.
https://pnewman.org/writing.html