What nobody tells you about documentation
There is four kinds of documentation: tutorials, how-to guides, explanation and reference. Each with their own structure and mode of writing.
- from
- Engineering Team Management
- added
- 2026-10-10
- likes
- 0
similar
-
Notes on Technical Writing mkaz.blog
An effective list of do and don't when it comes to writing documentation.
-
Technical Writing Courses developers.google.com
This collection of courses and learning resources aims to improve your technical documentation. Learn how to plan and author technical documents. You can also learn about the role of technical writers in a company.
-
Writing an engineering strategy lethain.com
A guide on how to write and document an engineering strategy.
-
All the best engineering advice I stole from non-technical people medium.com
“It's intriguing that the stuff that really seems to make a difference in the quality of software never seems to be about software.”
-
DevDocs devdocs.io
-
Write the Docs github.com
Engineering Team Management › Communication > Documentation: “There is four kinds of documentation: tutorials, how-to guides, explanation and reference. Each with their own structure and mode of writing.”