知识卡片
文档类型对应不同使用目的
设计文档解释结构与选择,用法文档帮助使用功能,操作文档指导部署、升级和管理。先判断目的,再决定结构和深度,避免把需要运行步骤的读者引到类图。一个任务可引用别类文档,不必把所有背景重复写入;分类是组织工具,不是禁止跨类关联。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第9章 文档化你的项目 构建文档集 · 查看原书依据
文档可以分为3类
参考来源
- 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元017;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。
- 结论依据:原文三类文档分别服务设计、使用和运行,支持按读者目的分工,跨类引用仍可避免重复背景。未在本机运行示例或改变环境。
- 原始内容:体现你的工作习惯。 软件项目中的一组常见文档可以分为3类。 设计 :包括提供架构信息和底层设计信息的所有文档,例如类图或数据库图。 用法 :包括有关如何使用软件的所有文档;可以是以一本手册和教程或模块级帮助的形式。 操作 :这