Lightweight Architecture Decision Records | 技术雷达

写在前面

ThoughtWorks每年都会出品两期技术雷达，这是一份关于科技行业的技术趋势报告，在四个象限：技术、平台、工具以及语言和框架对每一个条目（Blip）做采用、试验、评估、暂缓的建议。（参考阅读：解读技术雷达的正确姿势）

一直以来，我们都未对每一个Blip做进一步的解读，而这次决定尝试一个新的专栏——《雷达哔哔哔》，由作者根据自己实践与理解，对雷达中部分条目作出解析，致力于用一篇篇短小精悍的文字，帮助读者加深对雷达的理解。

今天是《雷达哔哔哔》的第一篇，Blip是Lightweight Architecture Decision Records

位置

2018年5月第18期技术雷达，技术象限，建议试验

目标受众：

• 系统架构师，技术管理者，开发设计人员

关注问题：

• 传统的重文档编写维护量大，随着业务发展，很难保持同步
• 在一些敏捷项目中，随着关键文档的缺失、项目Knowledge及决策丢失导致长生命周期的项目知识传递问题

解决方案：

• 使用“ Lightweight Architecture Decision Records”（轻量级架构决策记录）来记录项目的重要决策，并将其与代码等其他项目资产一样，纳入到版本控制系统之中。

解读：

“项目要不要写文档”一直是一个很有争议的问题。在过去，项目一般都要写众多的文档，类似于需求说明书、概要设计、详细设计、数据库设计、等balabala设计……而这些文档的作用往往只是为了【过评审】或是【招投标】，写文档的形式也更多是简单的复制粘贴。

项目拿下了，过审了，一旦开动起来，文档反而就被束之高阁，再也无人过问了。

很多人没日没夜地写着千篇一律的文档、文档、文档……终于有一天，盼来了敏捷，并看到了敏捷宣言中硕大的一句：

（敏捷宣言）

唉呀妈呀，终于见到了亲人，从此高举着敏捷的大旗，与文档势不两立。

再有人敢提起写文档，就把早已准备好的“敏捷大棒”从身后掏出来，劈头就是一棒槌……

不得不说，敏捷又一次背了口黑锅。敏捷宣言所推崇的并不是简单的不写文档，而是认为之前那种写文档的方式根本没有体现出其应有的价值。还 不如代码写的漂亮些，测试写的完备些，让代码和测试成为真正有价值的活文档。

而这，相对于简单的复制粘贴攒文档，对于团队的要求反而更高了。

世间万物，物极必反。

随着时间的推移，再好的敏捷团队也会出现知识流失的问题，尽管有着完备的测试和易读的代码，但这些毕竟过于细节，无法快速还原当时设计或重构时的所有上下文。

所以技术雷达推荐使用“ Lightweight Architecture Decision Records”来记录项目的重要决策，相比于传统文档，它最大的特点就是轻量（Lightweight），关注于创造价值而不是遵循流程。 让我们看个ADR的模板：

（ADR Template）

同时技术雷达也建议我们不要将ADR束之高阁、放到Wiki或是文档库中。而是随着代码放到Git或其他版本控制工具里，这样既可以保持最大程度与代码同步，又能跟踪Decision的变更历史。

推荐的Adr-Tools工具，可以帮助我们更容易的做到这些。

相关Blip及延展阅读：

• Lightweight Architecture Decision Records | Technology Radar | ThoughtWorks
• Blog | Documenting Architecture Decisions | Relevance
• GitHub - joelparkerhenderson/architecture_decision_record: Architecture decision record (ADR) examples for software planning, IT leadership, and template documenation
• Documenting Architectural Decisions Within Our Repositories — Embedded Artistry
• Architectural Decision Records | adr.github.io
• What are lightweight Architecture Decision Records?

工具：

GitHub - npryce/adr-tools: Command-line tools for working with Architecture Decision Records