Documenting Architecture and Design Decisions [ADR]
_______________________________
ADR (Architecture Decision Record)
https://github.com/joelparkerhenderson/architecture_decision_record/blob/master/adr_template_by_michael_nygard.md
https://github.com/joelparkerhenderson/architecture_decision_record
advantages of ADR:
- immutable docs, that do NOT need to be maintained!
- with source code, so easy to find
_______________________________
Design Docs at Google
https://www.industrialempathy.com/posts/design-docs-at-google/
(a useful general discussion, with interesting sections)
disadvantage: mutable docs that need to be maintained!
_______________________________
ADR (Architecture Decision Record)
https://github.com/joelparkerhenderson/architecture_decision_record/blob/master/adr_template_by_michael_nygard.md
https://github.com/joelparkerhenderson/architecture_decision_record
advantages of ADR:
- immutable docs, that do NOT need to be maintained!
- with source code, so easy to find
_______________________________
Design Docs at Google
https://www.industrialempathy.com/posts/design-docs-at-google/
(a useful general discussion, with interesting sections)
disadvantage: mutable docs that need to be maintained!
Comments
Post a Comment