知识卡片
标题应回应实际查找问题
按主题和任务组织章节,避免让架构总览埋在API细节中。用读者可能搜索的短语检验标题,目录才能帮助定位而不只是罗列写作顺序。信息齐全不代表可找到,文档应同时安排层级、入口和交叉引用,让不同问题有明确落点。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第9章 文档化你的项目 9.1.4 限制信息范围 · 查看原书依据
我在Google中输入什么短语来找到此部分
参考来源
- 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元006;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。
- 结论依据:原文用搜索短语检验章节标题,直接支持从查找任务设计目录,内容存在不等于能被目标读者找到。未在本机运行示例或改变环境。
- 原始内容:成。 撰写标题的一个简单做法是问自己:“我在Google中输入什么短语来找到此部分?”。