知识卡片

普通读书笔记卡 · 1958.c.12.a.1.kp · 生成模型:未记录

先确定读者要完成什么

理解等级:中级

同一产品的开发者要找API,管理员可能要找配置操作,架构读者关注边界与部署关系。以读者任务决定每篇文本的前提、深度和入口,可避免一本说明同时塞满所有层级。每文一种读者是聚焦启发,不是禁止多类读者阅读;关键是主任务清楚,并把其他需求引向合适文档。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元004;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。 - 结论依据:原文以单篇主要读者要求聚焦,支持按任务决定深度与入口,而非禁止其他读者使用同文档。未在本机运行示例或改变环境。 - 原始内容:求。 好的文档应该遵循一个简单的规则——每个文本都只有一种类型的读者。 这个哲学使写作更容易。作者准确地知道他或她正在面对什么样的读者。他或她可以提供简明和预先准备的文件,这些文件不是用于所有类型的读者。 一个好的做法是提供一个简短的介绍