Search the practice set
126 questions, 454 terms and 400 topics in 20 areas.
13 results for “Documentation Practice”
Architecture Decision Log
The ordered, immutable collection of a system's decision records, read as a history rather than as a specification.
Architecture Decision Record
A short, immutable document capturing one architectural decision, its context, the alternatives, and its consequences.
C4 Model
A set of four nested diagram levels — context, container, component, code — that keeps each diagram at one consistent level of abstraction.
Data Discovery
Automatically scanning stores to find where sensitive data actually resides, as distinct from where the documentation says it should.
FinOps
The practice of giving engineering teams visibility into and accountability for the cost of what they build and run.
OpenAPI
A machine-readable specification format for HTTP APIs, from which documentation, clients, servers, mocks and validation can be generated.
Runbook
A short, actionable document telling an on-call engineer what an alert means, what to check, and what the safe mitigations are.
Documentation Practice
Keeping documents close to the code and honest about staleness.
API Documentation
OpenAPI as a machine-checked contract rather than as prose.
Architecture Documentation
What to write down, at what altitude, and what nobody will ever read.
Decision Practice
Thresholds, review, supersession and keeping the log alive.
FinOps Practice
Inform, optimise, operate — and cost as a design-review criterion.