知识卡片
轻量设计文档说明范围与依据
设计文档可含摘要、读者、目标、结构图和参考,使读者理解这一份设计负责解释什么及依据何在。作者和标签可帮助正式设计讨论,但要随团队需要选择。三四页是限制范围的启发,复杂设计可分解成概览与专题,不应为页数删掉必要约束或风险。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第9章 文档化你的项目 构建文档集 · 查看原书依据
内容最多应为3页或4页
参考来源
- 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元017;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。
- 结论依据:原文设计模板包含目标、读者、图和参考,支持范围与依据可见;三四页只为约束范围,不要求删去必要风险。未在本机运行示例或改变环境。
- 原始内容:容(带图); 参考的其他文件。 打印时,内容最多应为3页或4页,以确保限制范围。如果它变大,应该分成几个文档或概述。 该模板还提供了作者的名字和一个标签列表来管理它的演变和简化分类。这将在本章后面讨论。 reST中的示例设计文档模板