1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
ADR Tools
=========
A command-line tool for working with a log of [Architecture Decision Records][ADRs] (ADRs).
[](https://travis-ci.org/npryce/adr-tools)
Quick Start
-----------
[Install ADR Tools](INSTALL.md).
Use the `adr` command to manage ADRs. Try running `adr help`.
ADRs are stored in a subdirectory of your project as Markdown files.
The default directory is `doc/adr`, but you can specify the directory
when you initialise the ADR log.
1. Create an ADR directory in the root of your project:
adr init doc/architecture/decisions
This will create a directory named `doc/architecture/decisions`
containing the first ADR, which records that you are using ADRs
to record architectural decisions and links to
[Michael Nygard's article on the subject][ADRs].
2. Create Architecture Decision Records
adr new Implement as Unix shell scripts
This will create a new, numbered ADR file and open it in your
editor of choice (as specified by the VISUAL or EDITOR environment
variable).
To create a new ADR that supersedes a previous one (ADR 9, for example),
use the -s option.
adr new -s 9 Use Rust for performance-critical functionality
This will create a new ADR file that is flagged as superceding
ADR 9, and changes the status of ADR 9 to indicate that it is
superseded by the new ADR. It then opens the new ADR in your
editor of choice.
3. For further information, use the built in help:
adr help
See the [tests](tests/) for detailed examples.
The decisions for this tool are recorded as [architecture decision records in the project repository](doc/adr/).
[ADRs]: http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions
|
