All Projects → npryce → Adr Tools

npryce / Adr Tools

Licence: other
Command-line tools for working with Architecture Decision Records

Programming Languages

shell
77523 projects
Makefile
30231 projects

Projects that are alternatives of or similar to Adr Tools

Log4brains
✍️ Log and publish your architecture decisions (ADR)
Stars: ✭ 98 (-96.81%)
Mutual labels:  documentation, markdown, architecture
C4 Builder
This is a documentation builder. You feed it .md and .puml and it exports a site, pdf, or a markdown with navigation.
Stars: ✭ 164 (-94.66%)
Mutual labels:  documentation, markdown, architecture
Mkdocs
Project documentation with Markdown.
Stars: ✭ 13,346 (+334.3%)
Mutual labels:  documentation, markdown
Vue Styleguidist
Created from react styleguidist for Vue Components with a living style guide
Stars: ✭ 2,133 (-30.59%)
Mutual labels:  documentation, markdown
Dvc.org
🔗 DVC website and documentation
Stars: ✭ 171 (-94.44%)
Mutual labels:  documentation, markdown
Reference Architecture
TELUS Reference Architecture Documentation
Stars: ✭ 145 (-95.28%)
Mutual labels:  documentation, architecture
Hads
📚 Markdown superpowered documentation for Node.js
Stars: ✭ 147 (-95.22%)
Mutual labels:  documentation, markdown
Wiki
Wiki.js | A modern and powerful wiki app built on Node.js
Stars: ✭ 14,985 (+387.63%)
Mutual labels:  documentation, markdown
Wiki
Awesome way to learn together! 🤣
Stars: ✭ 119 (-96.13%)
Mutual labels:  documentation, markdown
Cgx
💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)
Stars: ✭ 190 (-93.82%)
Mutual labels:  documentation, markdown
Tui.editor
🍞📝 Markdown WYSIWYG Editor. GFM Standard + Chart & UML Extensible.
Stars: ✭ 14,016 (+356.1%)
Mutual labels:  documentation, markdown
Swagger2markup
A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation.
Stars: ✭ 2,330 (-24.18%)
Mutual labels:  documentation, markdown
X0
Document & develop React components without breaking a sweat
Stars: ✭ 1,706 (-44.48%)
Mutual labels:  documentation, markdown
Unisolder Notes
Markdown documentation repo for building and chosing parts for Unisolder, the open source universal soldering iron controller
Stars: ✭ 138 (-95.51%)
Mutual labels:  documentation, markdown
Typemill
TYPEMILL is a simple and lightweight Flat-File-CMS for authors and publishers.
Stars: ✭ 150 (-95.12%)
Mutual labels:  documentation, markdown
Editor.md
The open source embeddable online markdown editor (component).
Stars: ✭ 11,741 (+282.07%)
Mutual labels:  documentation, markdown
Docs
Repository of Twilio SendGrid's product documentation.
Stars: ✭ 221 (-92.81%)
Mutual labels:  documentation, markdown
Catalog
Create living style guides using Markdown or React
Stars: ✭ 1,527 (-50.31%)
Mutual labels:  documentation, markdown
Docc
A starter documentation theme for Gridsome. Featuring instant search, great navigation and a dark mode!
Stars: ✭ 115 (-96.26%)
Mutual labels:  documentation, markdown
Press
Minimalist Markdown Publishing for Nuxt.js
Stars: ✭ 181 (-94.11%)
Mutual labels:  documentation, markdown

ADR Tools

A command-line tool for working with a log of Architecture Decision Records (ADRs).

Build Status

Quick Start

Install ADR Tools.

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.

  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 supercedes 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 superceded 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 for detailed examples.

The decisions for this tool are recorded as architecture decision records in the project repository.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].