知识卡片

不涉及的设计点也要明确写"无",而非留空

普通读书笔记卡

内容

架构设计文档的详细设计部分,如果某个方案确实不涉及某个复杂度维度(例如可扩展设计),书中给出一个容易被忽视但很实用的写作建议:应该在对应章节明确写上”无”,表示设计者已经考虑过这个维度、只是判断不需要针对性设计;而不能因为”不涉及”就干脆把这一节完全删掉不写。原因很直接:如果这部分内容完全不写,方案评审的时候评审人很容易把它误判成”设计者遗漏了这个设计点”,从而质疑方案的完整性,即便实际上设计者已经分析过、只是结论是”这里不需要额外设计”。这个细节体现了架构设计文档写作的一个通用原则:文档要能替设计者证明”我考虑到了、只是判断不用做”,而不是靠评审人自己去猜测某处空白到底是”想过但不需要”还是”根本没想到”。

参考来源

- 位置:《从零开始学架构》第50讲《架构实战:架构设计文档模板》"详细设计"之"可扩展设计"(源文件:_epub-src/OEBPS/text00003.html) - 结论依据:原文说明"如果方案不涉及,可以简单写上'无',表示设计者有考虑但不需要设计;否则如果完全不写的话,方案评审的时候可能会被认为是遗漏了设计点",直接支撑本卡结论。 - 原始内容:如果方案不涉及,可以简单写上"无",表示设计者有考虑但不需要设计;否则如果完全不写的话,方案评审的时候可能会被认为是遗漏了设计点