轻量级文档

问题

你需要为你的项目创建一个文档,但是你不想花太多时间在这上面。

项目在其生命周期中,最难追踪的事情之一就是:某些决定背后的动机。一个参与项目的新人。可能会因过去的决定而困惑、迷惑、高兴或者激怒。如果不能了解其原因或者后果,此时这个人只有两个选择:

  1. 一味地接受这个决策
  2. 盲目地改变它

所以,我们需要将保留一系列 “重大架构” 决策的记录:影响架构、非功能需求、依赖关系、接口或构造技术的记录。

解决方案

示例:RFC - request for comment

示例:ADR - 架构决策记录

架构决策记录(Architecture Decision Records,简称 ADR)是一种记录架构决策的方法,用于记录项目中的重要决策,以便于将来查阅。它们通常包含以下内容:

  • 问题描述
  • 背景
  • 解决方案
  • 评估
  • 后续行动

参考资料