Rules for Writing Software Tutorials
a day ago
- 使用清晰、以结果为导向的标题和引言，向初学者说明目标。
- 尽早展示最终结果，使代码片段可复制粘贴，并使用长命令行选项。
- 通过环境变量或命名常量将用户定义的值与可重用逻辑分开。
- 使用明确、真实的示例值，避免行话，让教程对初学者友好。
- 最小化依赖，保持代码处于可工作状态，并一次只教授一个概念。
- 使用一致、描述性的标题，明确指定文件名，并演示解决方案有效。
- 提供完整示例仓库的链接，理想情况下为每个教程阶段设置分支。