知识卡片
文档份量由真实任务决定
小型工具可能只需说明配置与运行的README,而不是先建立一整套空的文档目录。轻量且充分意味着足以让目标读者完成任务,需包含必要前提和边界,不等于越短越好。ianitor案例只是原书当时的单文档示例,不能由管理员角色推断今后没有其他维护需求。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
参考来源
- 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元008;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。
- 结论依据:原文明示先定义实际需求,小工具以README满足任务,支持充分性依使用场景而非目录或篇幅规模判断。未在本机运行示例或改变环境。
- 原始内容: Process 中解释了一个好的做法是定义真正的文档需求,而不是创建一个详尽的文档集。 例如,让我们看一个简单项目ianitor的示例文档——它在GitHub https://github.com/ ClearcodeHQ/i