知识卡片
源文档结构和阅读导航可分开
作者需要在版本库中找到并维护唯一源文件,读者需要按问题浏览、搜索和沿链接前进。docs/source下的设计、用法、操作目录服务维护,生成网站可在其上提供另一层导航;两者不必机械一一对应。索引若依赖手工列表容易漏更,可自动生成部分内容,但读者逻辑仍需人工设计。
结构图:
flowchart LR
A[版本库中的源文档与代码] --> B[文档构建]
B --> C[读者入口与目录]
B --> D[搜索和交叉引用]
C --> E[按任务查找说明]
D --> E
note[维护布局和消费布局职责不同,可共享同一内容源]
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第9章 文档化你的项目 9.4.1 构建格局 · 查看原书依据
为生产者(作家)建立一树形布局
参考来源
- 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元019;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。
- 结论依据:原文为写作者建源树、为读者建导航,直接支持维护唯一来源与多入口阅读两种组织需求,不必逐层一一对应。未在本机运行示例或改变环境。
- 原始内容:作者和读者。 构建文档格局有两个步骤。 为生产者(作家)建立一树形布局。 在生产者树形布局的顶部为消费者(读者)构建树形布局。 生产者和消费者之间的这种区分是重要的,因为他们在不同的地方并且以不同的格式访问文档。 1.生产者的布局 从生产者