客服电话
APP下载
迪恩网络APP
随时随地掌握行业动态
官方微信
扫描二维码
关注迪恩网络微信公众号
ADR - Architecture Decision Records（轻量级架构决策记录工具）
Inspired by https://github.com/npryce/adr-tools, but supported Windows. ADR Blogpost: Documenting Architecture Decisions A good material about Architecture decision record 中文翻译：架构决策记录 功能特性
Features
HTML Reporter ExampleScreenshotsADR List
ADR Reporter
Install
npm install -g adr
adr init <language>e.x: newadr new <decision>e.x: listadr listresult: ╔══════════════════════════════════════╤══════════════╤═══════════════════╗║ Decision │ Last Modified│ Last Status ║╟──────────────────────────────────────┼──────────────┼───────────────────╢║ 1.编写完整的单元测试 │ 2017-11-26 │ 2017-11-26 已完成 ║╟──────────────────────────────────────┼──────────────┼───────────────────╢║ 2.添加目录生成 │ 2017-11-26 │ 2017-11-25 已完成 ║╟──────────────────────────────────────┼──────────────┼───────────────────╢║ 3.图形生成功能 │ 2017-11-26 │ 2017-11-24 已完成 ║╟──────────────────────────────────────┼──────────────┼───────────────────╢║ 4.生成在线图形 │ 2017-11-26 │ 2017-11-22 提议 ║╚══════════════════════════════════════╧══════════════╧═══════════════════╝generate tocadr generate tocresults: # Architecture Decision Records* [1. 编写完整的单元测试](001-编写完整的单元测试.md)* [2. 添加目录生成](002-添加目录生成.md)* [3. 图形生成](003-图形生成.md)generate graphadr generate graphresults: digraph { node [shape=plaintext]; _1 [label="1.编写完整的单元测试"; URL="001-编写完整的单元测试.md"] _2 [label="2.添加目录生成"; URL="002-添加目录生成.md"] _1 -> _2 [style="dotted"]; _3 [label="3.图形生成"; URL="003-图形生成.md"] _2 -> _3 [style="dotted"];}update filename by titleadr updatedecisions change logsadr logs <index>e.x. ╔════════════╤══════╗║ - │ - ║╟────────────┼──────╢║ 2017-11-23 │ 提议 ║╟────────────┼──────╢║ 2017-11-24 │ 通过 ║╚════════════╧══════╝export adrsupport: json, csv, html, markdown adr export <type>e.x. Index, 决策, 上次修改时间, 最后状态1, 编写完整的单元测试, 2017-11-26, 2017-11-26 已完成2, 添加目录生成, 2017-11-26, 2017-11-25 已完成3, 图形生成功能, 2017-11-26, 2017-11-24 已完成search adradr search <keyword>e.x. ╔══════════════════════╤══════════════════╗║ 决策 │ 最后状态 ║╟──────────────────────┼──────────────────╢║ 19.添加-e2e-测试 │ 2017-11-28 提议 ║╟──────────────────────┼──────────────────╢║ 1.编写完整的单元测试 │ 2017-11-26 完成 ║╚══════════════════════╧══════════════════╝Configcurrent:
example config: { "path":"doc/adr/", "language":"zh-cn", "prefix": "", "digits": 4}License
@ 2017~2021 A Phodal Huang's Idea. This code is distributed under the MIT license. See  |
请发表评论