Skip to content

kopach/adr-templates

Repository files navigation

adr-templates

Architectural Decision Record templates for a lightweight ADR toolset adr-tools and Visual Studio Code ADR toolset extension adr-tools

How to name ADRs

  • These documents have names that are short noun phrases

Where to start

See first decision example 0001-documenting-architecture-decisions.md. Copy/paste it to you ADR log folder and use as starting point.

Architectural drivers

Architectural drivers to consider

  • Functional requirements
  • Qualitative attributes
    • scalability
    • extensibility
    • security
    • auditability
    • configurability
    • observability
  • Project restrictions
    • time
    • budget
    • knowledge
  • Conventions
    • Company wide rules & conventions
    • Other forces (e.g. choosing technology to be competitive on market)

Examples

See karma-sabarivka-reporter project for ADR examples in real project

Licence

This software is licensed under the MIT

About

ADR (Architectural Decision Record) templates

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published