Manage technical debt with DAGs for Documentation.
Documenting Architecture Decision Records (ADRs) lets your team have always up to date documentation on system design decisions without having to rely on tribal knowledge.
Documenting Architecture Decision Records (ADRs) lets your team have always up to date documentation on system design decisions without having to rely on tribal knowledge.
Team compositions change. Without proper system documentation teams become fearful of making changes and are faced with two poor choices:
1. Do nothing to avoid breaking the system, but no progress can be made.
2. Re-architect the system based without understanding the original design decisions at the cost of higher effort and risk.
Architecture Decision Records (ADRs) are a low effort high value documentation format.
Each ADR has relationship to previous documentation that forms a DAG so its always clear which documentation is still relevant.
Clearer documentation empowers engineers to ship faster with more certainty and less risk.
Publishing ADRs helps scale architectural understanding and best practices and reduces reliance on tribal knowledge.
Publish Architecture Decision Records from anywhere and connect them to previous ADRs using a simple UI form with live previewing. See an example ADR
Schema enforcement makes sure that everyone on your team publishes ADRs in a consistent format.
ADRs are automatically searchable, making it easier to find documentation and get back to building product.
Search also facilitates greater cross team knowledge sharing and reduces duplicate effort. A search during the planning stages of a project can show you how other teams may have already solved a problem.
ADR view counts let you know how often each decision is read and which are read the most frequently.
ADR publish counts over time can show the architectural evolution of services as well as their maturity.
Tracking these metrics gives you visibility into returns from documentation efforts. Each view means you saved your team some time.
