Skip to content

Rename docs/adr default directory to docs/decisions to improve usage #12

Open
@thomvaill

Description

@thomvaill

Feature Request

Feature Suggestion

For now, the default directory for ADRs is docs/adr, because it was commonly documented like this:

But @joelparkerhenderson recently gave me this interesting feedback:

Some teams much prefer the name "decisions" over the abbreviation "ADRs". When some teams use the directory name "decisions", then it's as if a light bulb turns on, and the team starts putting more information inton the directory, such as vendor decisions, planning decisions, scheduling decisions, etc. All of these kinds of information can use the same template. We hypothesize that people learn faster with words ("decisions") over abbreviations ("ADRs"), and people are more motivated to write work-in-progress docs when the word "record" is removed, and also some developers and some managers dislike the word "architecture".

So I propose to change the default value in Log4brains, because I am convinced that ADRs should not be reserved only for important architectural decisions. They are also beneficial for all kind of decisions, and we should promote that.

Possible Implementation

  • Search and replace all occurrences of docs/adr in the README
  • Search and replace all occurrences of docs/adr in the code, only when it is used as a default value
  • Create an ADR for this :-)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions