A friend has been struggling with under-documented projects (*cough* zoo software). This raised the question, what makes good documentation? And what is a good documentation system? Here’s my opinion backed with some sources.
Code As Documentation
- Code that communicates it’s intent well is the best documentation
- This is largely driven by structure and names
- Tests document code usage and expectations
- Shouldn’t repeat the code
- Explains what code can’t explain: motivations, trade-offs, considered alternatives, reasoning
- Infrequently changes when code changes
- Should be discoverable when and where you need it
- should generally live in the code base and in source control.
My Documentation Guides
Here is my rule of thumb for how I document common types of information. The items are formatted as
info to document -> documentation technique
- sources, gotchas, explanations of non-obvious decisions -> code comments
- requirements -> tests (usually Test Api or Gherkin-named tests)
- domain concepts -> Code structure and names (class, function, parameter, etc), Ubiquitous Language glossary
- motivations and trade-offs -> most typically in ducks or Architectural Decision Records
- Overviews, getting started, high-level design patterns, style guides, project contacts -> readme
Project documentation should live in the project source control. Shared documents, like company style guides, should generally still be linked to from docs in the repository.
I’ve also found it helpful to have some team or company landing page of projects. Each has a quick summary, location of resources, the project owner, and maybe a project status.
My opinion on documentation is largely based on the following sources, plus experience.
- Code Complete. Especially Chapter 32: Self-Documenting Code
- informed naming strategies, low-level design strategies, code as the only up-to-date document, granularity of comments, etc
- The Pragmatic Programmer
- Documentation discussed throughout with themes of explaining tradeoffs, motivations, assumptions, investigations.
- Design of Design
- Domain Driven Design. Especially Ch 2
- Inspired capturing domain concepts in code, term glossaries. Reinforced non-code documents as overview and motivation-level documents.
- Robert Martin was my exposure to tests as documentation
- Tool Support For Project Tracking
- documents belong in source control