joelparkerhenderson / architecture-decision-record

Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation
Other
11.59k stars 2.4k forks source link

docs(readme): include template with rationale + translations #40

Closed acdcjunior closed 3 years ago

acdcjunior commented 3 years ago

This suggestion adds a fairly well used template by Paulo Merson (co-author of Documenting Software Architectures, Second Edition).

This templates main addition is a Rationale section, plus some translated versions (spanish, portuguese, chinese).

joelparkerhenderson commented 2 years ago

Thanks! I added the example link manually, because the PR got mistakenly canceled by GitHub when the primary branch name changed from "master" to "main".

acdcjunior commented 2 years ago

Thanks! One minor thing: I see you added it to the TOC, but not to the ADR example templates section. That's OK if it was intentional, but I just thought I'd mention it. Again, thanks!!