知识卡片

判断架构文档合格的测试:追问不明显的原因

普通读书笔记卡 · 2170

内容

判断一份架构文档是否合格的简单测试是:它是否包含重大决策及其背后不够明显的原理。像”我们对前后台代码做了分离”“我们使用了监控”这类描述,就像”我的门着地,因此人们可以走进来”一样没有意义,通不过测试。真正该讨论的是那些原因不够明显、或折中较多的决策,比如”你是否使用了服务层,为什么”。发散:写架构文档时先自问,去掉这句话是否会让读者损失信息——损失不了,说明它只是常识而非决策。

参考来源

- 位置:《架构师应该知道的37件事》第2章《架构》之"2.2 这是架构吗"·"2.2.5 通过测试"(源文件:_epub-src/OEBPS/Text/chapter002.html) - 结论依据:原文说明"诸如'我们对前后台代码做了分离''我们使用了监控'或者'迁移系统风险太大'等,听起来就像是'我的门着地,因此人们可以走进来'……一样没有意义。相反,讨论架构时,应该讨论哪些原因不够明显或者某些决策为什么会有太多的折中",直接支撑本卡结论。 - 原始内容:比如,"你是否使用了服务层,为什么"(有些人可能认为这个也很明显)或者"为什么你使用了一个面向会话的协议"。