Skip to content

surovtsev/madr-ru

BranchesTags
 
 

Repository files navigation

Markdown Architectural Decision Records part of ADR

"Markdown Architectural Decision Records" (MADR) [ˈmæɾɚ] – architectural decisions that matter [ˈmæɾɚ].

News

Overview

An Architectural Decision (AD) is a software design choice that addresses a functional or non-functional requirement that is architecturally significant. This might, for instance, be a technology choice (e.g., Java vs. JavaScript), a choice of the IDE (e.g., IntelliJ vs. Eclipse IDE), a choice between a library (e.g., SLF4J vs java.util.logging), or a decision on features (e.g., infinite undo vs. limited undo). Do not take the term "architecture" too seriously or interpret it too strongly. As the examples illustrate, any decisions that might have an impact on the architecture somehow are architectural decisions.

It should be as easy as possible to a) write down the decisions and b) to version the decisions.

This repository offers a solution to record architectural decisions. It provides files to document Architectural Decisions using Markdown and Architectural Decision Records.

The decisions are placed in the folder docs/adr to

  1. Enable GitHub pages to render it using the web. See https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/ for more information.
  2. Separate the architectural decisions from other documentation.

The filenames are following the pattern NNNN-title-with-dashes.md (ADR-0005), where

  • NNNN is a consecutive number and we assume that there won't be more than 9,999 ADRs in one repository.
  • the title is stored using dashes and lowercase, because adr-tools also does that.
  • the suffix is .md, because it is a Markdown file.

Table of Contents

The Template

The template reads as follows:

# [короткий заголовок проблемы и решения]

* Статус: [предложение | отвергнуто | принято | устарело | … | поглощено [ADR-0005](0005-example.md)] <!-- опционально -->
* Принявшие решение: [список всех кто был вовлечен в принятие решения] <!-- опционально -->
* Дата: [YYYY-MM-DD когда решение было обновлено] <!-- опционально -->
* Использованный шаблон: [MADR 3.0.0](https://adr.github.io/madr/) <!-- опционально -->

Техническая история: [описание | ссылка на запрос/задачу ] <!-- опционально -->

## Контекст и описание проблемы

[Описание контекста и описания проблемы, например, в простой форме, двумя или тремя предложениями. Вы можете выразить проблему в форме вопроса.]

## Факторы принятия решения <!-- опционально -->

* [ограничение 1, например, фактор, проблема с которой столкнулись, …]
* [ограничение 2, например, фактор, проблема с которой столкнулись, …]
* … <!-- количество факторов при принятии решения может быть разным -->

## Рассмотренные варианты

* [вариант 1]
* [вариант 2]
* [вариант 3]
* … <!-- количество вариантов может быть разным -->

## Итоговое решение

Выбран вариант: "[вариант 1]", потому что [обоснование. например, только один вариант, который удовлетворяет ограничениям | который решает проблему | … | подходит лучше всего].

### Положительные последствия <!-- опционально -->

* [например., улучшение качественных показателей, следует принять решения, …]
* …

### Отрицательные последствия <!-- опционально -->

* [например., ущерб для качественных показателей, следует принять решения, …]
* …

## Плюсы и минусы вариантов <!-- опционально -->

### [Вариант 1]

[пример | описание | ссылка по теме | …] <!-- опционально -->

* хорошо, потому что [аргумент a]
* хорошо, потому что [аргумент b]
* плохо, потому что [аргумент c]
* … <!-- количество за и против могут быть разным -->

### [Вариант 2]

[пример | описание | ссылка по теме | …] <!-- опционально -->

* хорошо, потому что [аргумент a]
* хорошо, потому что [аргумент b]
* плохо, потому что [аргумент c]
* … <!-- количество за и против могут быть разным -->

### [Вариант 3]

[пример | описание | ссылка по теме | …] <!-- опционально -->

* хорошо, потому что [аргумент a]
* хорошо, потому что [аргумент b]
* плохо, потому что [аргумент c]
* … <!-- количество за и против могут быть разным -->

## Ссылки <!-- опционально -->

* [Вид ссылки] [Ссылка на ADR] <!-- например: Предложение [ADR-0005](0005-example.md) -->
* … <!-- количество ссылок может быть разным -->

The template is available at template/template.md.

Example

# Use Markdown Architectural Decision Records

## Context and Problem Statement

We want to record architectural decisions made in this project.
Which format and structure should these records follow?

## Considered Options

* [MADR](https://adr.github.io/madr/) 2.1.0 - The Markdown Architectural Decision Records
* [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) - The first incarnation of the term "ADR"
* [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) - The Y-Statements
* Other templates listed at <https://github.com/joelparkerhenderson/architecture_decision_record>
* Formless - No conventions for file format and structure

## Decision Outcome

Chosen option: "MADR 2.1.0", because

* Implicit assumptions should be made explicit.
  Design documentation is important to enable people understanding the decisions later on.
  See also [A rational design process: How and why to fake it](https://doi.org/10.1109/TSE.1986.6312940).
* The MADR format is lean and fits our development style.
* The MADR structure is comprehensible and facilitates usage & maintenance.
* The MADR project is vivid.
* Version 2.1.0 is the latest one available when starting to document ADRs.

The example is rendered at template/0000-use-markdown-architectural-decision-records.md

For the MADR project itself, all ADRs exist at docs/adr/.

Apply it to your project

Initialization

Create folder docs/adr in your project. Copy all files in template from the MADR project to the folder docs/adr in your project.

For instance, using npm, this can be done using the following command:

npm install madr && mkdir -p docs/adr && cp node_modules/madr/template/* docs/adr/

Create a new ADR

Manual approach:

  1. Copy template.md to NNNN-title-with-dashes.md, where NNNN indicates the next number in sequence.
  2. Edit NNNN-title-with-dashes.md.
  3. Update index.md, e.g., by executing adr-log -d . You can get adr-log by executing npm install -g adr-log.

Note you can also use other patterns for the directory format, but then the tools cannot be applied.

Automatic approach:

Use our fork of adr-tools. See npryce/adr-tools#43 for the current status of integration.

Development

Releasing a new version:

  1. Update CHANGELOG.md.
  2. Update README.md with the new template and the example.
  3. Adapt the version reference in template/0000-use-markdown-architectural-decision-records.md.
  4. Copy template/0000-use-markdown-architectural-decision-records.md to docs/adr/0000-use-markdown-architectural-decision-records.md.
  5. Update package.json, publish to npmjs, create GitHub release.
    Use release-it (do not create a release on GitHub) and github-release-from-changelog.

License

License: CC0

About

Markdown Architectural Decision Records

adr.github.io/madr/

Resources

Readme

License

CC0-1.0 license
Activity

Stars

5 stars

Watchers

1 watching

Forks

1 fork
Report repository

Releases

14 tags

Packages

No packages published