19 docs tagged with "documentation"

Logical, process, physical, development views and use case scenarios

Organize ADRs and track impacts across codebase

Structure and best practices for writing architecture decisions

Comprehensive checklist for reviewing API design covering REST/GraphQL/gRPC compliance, versioning strategies, security headers, rate limiting, documentation, and error handling.

Ensure rigor and completeness in architecture reviews

Template for documenting architecture decisions including context, rationale, consequences, and alternatives. Enables searchable decision history and informed future decisions.

Capture decisions, rationale, alternatives, and traceability

Hierarchical diagrams at four levels of abstraction

Maintain consistency and freshness of architecture diagrams

UML, diagrams-as-code, and governance for architecture diagrams

Version control, automation, and consistency for architecture diagrams

Architecture decision records, views and viewpoints, diagramming, and reference architectures

Make decisions actionable and discoverable in codebase

Common stacks, checklists, risk registers, and mitigation plans

Version releases meaningfully; communicate changes clearly to stakeholders.

Identify, assess, and mitigate architectural risks

Capture dynamic behavior, infrastructure, and data flow

UML notation for architecture documentation

4+1 Model and C4 Model for representing architecture at multiple levels