documenter

Level-based documentation organizes product decisions, API contracts, and architectural notes into distinct levels to maintain traceability and consistency across different scopes. It captures rationale across features, APIs, and operations to keep records current with code changes.

To create an ADR for a new feature, apply provided ADR templates to document the architecture decisions and then update the architecture decisions registry to reflect the latest changes. This ensures decisions are traceable and consistent.

Runbook templates provide standardized governance to document operational plans and setup procedures across teams. They ensure operational documentation stays current with system evolution by applying level-based organization to operational evidence and rationale.

Yes, level-based documentation works for API contracts and product decisions by organizing them into distinct levels. This approach ensures traceability and consistency across different scopes, from features and APIs to setup and operations.

The best way to maintain architecture documentation is through lifecycle governance, which ensures documentation stays current with code changes and system evolution. This approach uses level-based organization to keep ADRs and runbooks updated.

Use an ADR template when you need to document specific architecture decisions and their rationale for traceability. Use a general runbook when documenting operational plans and setup procedures across teams to ensure consistent execution.