Start here · Essential guide
Documentation Practice for Engineering Teams
How engineering teams decide what to document, where documents should live and who keeps them current, with a practical way to start without drowning in pages.
Software Practice
Documentation Practice
Writing and maintaining documentation people actually use.
Building a Personal Engineering Glossary
Why a personal glossary helps when you learn a new field or join a project, and a simple method for recording, organising and reviewing technical terms.
Code Comments: When and How to Write Them
What code comments should explain, what they should not repeat, and practical habits for keeping comments accurate as the code around them changes.
Design Decision Records Explained
What a design decision record is, what it should contain and how short written records of choices and tradeoffs help future readers understand why things are as they are.
Drawing Clear Engineering Diagrams
How to choose between block diagrams, flowcharts and other diagram types, and the habits that keep engineering diagrams readable, consistent and easy to maintain.
How to Write a README That Helps
The sections a project README needs so a newcomer can understand and run the work, from purpose and setup to usage, status and where to get help.
Keeping Documentation Up to Date
Why documentation drifts away from the real system and the practical habits, from ownership to review triggers, that help stop documents becoming stale.
Note-Taking Tools and Methods for Engineers
A general comparison of paper notebooks, plain text files and wiki-style notes for capturing technical work, with guidance on choosing and combining them.
Writing Clear Step-by-Step Procedures
How to structure instructions and work procedures so they can be followed without guesswork: one action per step, clear order, expected results and testing.
Related topics