知识卡片
配方与教程解决不同阅读任务
配方围绕一个明确问题,给出读者、前提、解决步骤和参考;教程带领读者逐步掌握较完整功能,可串联多份配方。两者都需说明起点和预期结果,不应把API条目堆起来便叫教程。版本库能保存修改历史,但文档面向哪个软件版本仍须清楚,不能因不手写日期就丢掉适用边界。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第9章 文档化你的项目 构建文档集 · 查看原书依据
教程和配方相比有着不同的目的
参考来源
- 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元017;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。
- 结论依据:原文明示教程和配方目的不同,支持单问题操作与渐进学习路线分开,两者都需起点与结果而不是堆API。未在本机运行示例或改变环境。
- 原始内容:er documents. (2)教程 教程和配方相比有着不同的目的。它不打算解决孤立的问题,而是描述如何逐步使用应用程序的功能。这可能比配方更长,并且可能涉及应用程序的许多部分。例如,Django在其网站上提供了一个教程列表。 Writ