用途:教程 / 操作指南 / 高级解释。前置:可检查的能力与补课入口。适用环境:平台、工具链、依赖。
描述读完能独立完成什么;用可观察行为替代“掌握”“精通”。指出哪些扩展放到后续章节。
用熟悉的情境引入问题,再说明机制和名称。就地解释后链接完整参考,不强迫读者靠跳转理解当前步骤。
每步给出:目标、文件位置、完整代码或片段的上下文、执行命令、预期结果。一次只引入解决当前问题所需的新概念。
从输入经过关键函数或状态变化到输出,说明错误在哪里被发现和处理。必要时使用流程图。
加入空输入、错误输入、取消、重启或重复操作等适用情境。解释结果与原例的差异。
给出任务、输入、预期结果与提示。附参考思路;大型代码可以放在配套文件,但不能缺失必要定义。
按现象 → 证据 → 原因 → 修正组织,避免没有上下文的最佳实践清单。
给出真实存在的下一课与参考链接。记录本例实际验证过的环境、命令及尚未验证的部分。