Practical Patterns for Technical Writing

4 years ago qvault.io

Summary: This is a summary of an article originally published by the source. Read the full original article here →

If you have some experience with technical documents, you will probably agree that there is nothing more frustrating than bad documentation. Lately, technical writing became a more important part of my job, so I put together some of my findings.

If you spot passive voice in your documents (form of be + past participle), try to convert it to active voice to make it more direct.

If you have to, make it clear to the reader (i.e. “Golang, or Go for short”)

If you want to know more about the topic or have a chat, I am happy to talk to you.

DevOps Articles