- 1. 编写完整的单元测试
- 2. 添加目录生成
- 3. 图形生成功能
- 4. 生成图形关系
- 5. 保持功能与 ADR-TOOLS 基本一致
- 6. 添加 update 功能来通过内容更新文件
- 7. 在 list 展示 ADR 的状态
- 8. 使用 logs 查看指定 index 状态记录
- 9. 提供多语言支持
- 10. 更友好的 CLI
- 11. 添加 3 位数到 4 位数升级的支持
- 12. 重构重复代码到 TypeScript 风格
- 13. 考虑添加 link CLI 来映射对应关系
- 14. 考虑添加 tag CLI 来使用标签查询
- 15. 考虑添加 export 功能来导出 ADR
- 16. 使用不同色彩来标注不同的状态
- 17. 生成 HTML 报表
- 18. 考虑添加对 VS Code 和 Atom 编辑器的插件支持
- 19. 添加 E2E 测试
- 20. i18n 增加更新语言功能
- 21. 思考更好的 ADR 格式
- 22. 考虑添加索引前缀等参数,来匹配一些额外的情况
- 23. 可以使用命令行修改状态
- 24. 支持自定义模板路径
- 25. 日本語テンプレート定義
1. 编写完整的单元测试
日期: 2017/11/22
状态
2017-11-22 提议
2017-11-26 完成
上下文
当前,项目的单元测试比较少
决策
决定进行编写单元测试
结果
ava.js 目前不支持对文件的 mock,导致一定的问题
2. 添加目录生成
日期: 2017/11/22
状态
2017-11-22 提议
2017-11-25 完成
上下文
在这里补充上下文...
决策
在这里补充上决策信息...
结果
创建 READE.md 在 doc 目录下
3. 图形生成功能
日期: 2017/11/22
状态
2017-11-22 提议
2017-11-24 完成
上下文
在这里补充上下文...
决策
在这里补充上决策信息...
结果
在这里记录结果...
4. 生成图形关系
日期: 2017/11/22
状态
2017-11-22 提议
2017-12-01 通过
上下文
不同的 ADR 之间,存在一定的依赖关系。我们应该可以展示这些关系
决策
使用 vis.js 等在线工具尝试,例如:https://github.com/slior/adrflow
结果
在这里记录结果...
5. 保持功能与 ADR-TOOLS 基本一致
日期: 2017/11/22
状态
2017-11-22 提议
2017-11-26 已弃用
上下文
在这里补充上下文...
决策
在这里补充上决策信息...
结果
在这里记录结果...
6. 添加 update 功能来通过内容更新文件
日期: 2017-11-23
状态
2017-11-23 提议
2017-11-24 完成
上下文
在这里补充上下文...
决策
在这里补充上决策信息...
结果
在这里记录结果...
7. 在 list 展示 ADR 的状态
日期: 2017-11-23
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-23 提议
2017-11-23 通过
2017/11/24 完成
上下文
在这里补充上下文...
决策
在这里补充上决策信息...
结果
在这里记录结果...
8. 使用 logs 查看指定 index 状态记录
日期: 2017-11-23
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-23 提议
2017-11-25 完成
上下文
我想查看某一个指定记录的状态记录
决策
使用导出的 HTML 来查找
可以使用诸如 find-in-files 的 Node.js 库来实现。
结果
在这里记录结果...
9. 提供多语言支持
日期: 2017-11-23
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-23 提议
2017-11-23 通过
上下文
当前只支持中文模板,但是可以支持更多的语言
决策
添加英语支持,并能匹配不同的语言
结果
在这里记录结果...
10. 更友好的 CLI
日期: 2017-11-23
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-23 提议
背景
当前的 CLI,不支持默认参数,在显示上不友好
决策
添加额外的输入手段
后果
在这里记录结果...
11. 添加 3 位数到 4 位数升级的支持
日期: 2017-11-24
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-24 提议
2017-11-30 完成
背景
在这里补充上下文...
决策
在这里补充上决策信息...
后果
在这里记录结果...
12. 重构重复代码到 TypeScript 风格
日期: 2017-11-25
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-25 提议
2017-11-29 通过
背景
在这里补充上下文...
决策
在这里补充上决策信息...
后果
在这里记录结果...
13. 考虑添加 link CLI 来映射对应关系
日期: 2017-11-26
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-26 提议
背景
在这里补充上下文...
决策
在这里补充上决策信息...
后果
在这里记录结果...
14. 考虑添加 tag CLI 来使用标签查询
日期: 2017-11-26
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-26 提议
背景
在这里补充上下文...
决策
在这里补充上决策信息...
后果
在这里记录结果...
15. 考虑添加 export 功能来导出 ADR
日期: 2017-11-26
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-26 提议
2017-11-29 完成
背景
在这里补充上下文...
决策
添加 CSV、JSON 输出支持
后果
在这里记录结果...
16. 使用不同色彩来标注不同的状态
日期: 2017-11-27
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-27 提议
2017-11-27 完成
背景
当我们使用 list 为查看状态时,不容易区分不同的状态
决策
使用 chalk 来标注不同的状态
后果
在这里记录结果...
17. 生成 HTML 报表
日期: 2017-11-27
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-27 提议
2017-11-29 完成
背景
在这里补充上下文...
决策
合成完成的 Markdown 文件,再将 Markdown 文件转换成 HTML
后果
在这里记录结果...
18. 考虑添加对 VS Code 和 Atom 编辑器的插件支持
日期: 2017-11-27
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-27 提议
背景
在这里补充上下文...
决策
在这里补充上决策信息...
后果
在这里记录结果...
19. 添加 E2E 测试
日期: 2017-11-28
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-28 提议
背景
在这里补充上下文...
决策
在这里补充上决策信息...
后果
在这里记录结果...
20. i18n 增加更新语言功能
日期: 2017-11-28
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-28 提议
背景
在这里补充上下文...
决策
在这里补充上决策信息...
后果
在这里记录结果...
21. 思考更好的 ADR 格式
日期: 2017-11-28
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-28 提议
背景
当前的 ADR 格式可以满足大部分的情况,但是我们仍然需要考虑更好的格式。
可参考的项目:https://github.com/joelparkerhenderson/architecture_decision_record
决策
在这里补充上决策信息...
后果
在这里记录结果...
22. 考虑添加索引前缀等参数,来匹配一些额外的情况
日期: 2017-11-29
状态
列表:提议/通过/完成/已弃用/已取代
2017-11-29 提议
2017-11-30 完成
背景
在 Arachne 框架中,使用的是自定义的前缀,使用起来有些不一致的地方
示例:https://github.com/arachne-framework/architecture
决策
在系统参数中,添加 prefix 作为前缀来匹配值
后果
在这里记录结果...
23. 可以使用命令行修改状态
日期: 2017-12-01
状态
列表:提议/通过/完成/已弃用/已取代
2017-12-01 提议
背景
当我们可以使用 list 来查看某个 ADR 的状态后,我们还应该能使用命令行修改具体的状态
决策
使用如下的格式来修改状态:
adr status 1 通过
后果
在这里记录结果...
24. 支持自定义模板路径
日期: 2017-12-01
状态
列表:提议/通过/完成/已弃用/已取代
2017-12-01 提议
背景
在这里补充上下文...
决策
在这里补充上决策信息...
后果
在这里记录结果...
25. 日本語テンプレート定義
日付: 2024-11-09
アーキテクチャ決定の簡単な説明
ステータス
2024-11-09 提案されました
コンテキスト
この決定を行った状況
決定
決定とその根拠
影響
この決定による影響
コプライアンス
この決定が遵守されていることを確認する方法
備考
けの決定のメタデータ(著者など)