- 设计文档迫使你在实施之前仔细考虑重要决策,从而节省时间并避免代价高昂的错误。
- 它是在团队成员和合作伙伴团队之间协调设计决策的最佳方式,尤其适用于复杂或风险高的项目。
- 当多人协作、项目周期超过三个月、在生产环境中运行多年、涉及跨团队工作、目标不明确或存在灾难性风险时,应编写设计文档。
- 投入的精力应与项目的复杂性成正比;简单的项目可能只需一页纸,而复杂的项目可能需要50页的文档并经过签字批准。
- 只包含那些错误代价高的决策——琐碎的选择(例如分页样式)不属于设计文档的内容。
- 关键组成部分:标题、元数据、目标、背景、相关文档、目标、非目标、场景、图表、术语表、约束条件、服务等级目标、监控、时间线、接口、依赖关系、安全性、隐私、法律、日志记录、未解决问题、已解决问题和考虑的替代方案。
- 通过向团队分享设计文档并运用技巧来获取有用的反馈,同时避免阻碍进展,从而推动设计文档的评审。