简介
Codelab 是使用 Markdown 语法编写的互动式教程。我们在 blocklycodelabs.dev 上发布 Codelab。Codelab 结合使用自然语言、代码示例和屏幕截图，打造更有趣的教程体验。Codelab 的目标用户会遵循并在阅读时运行代码。
编写 Codelab 是为社区做贡献的绝佳方式。您可以在这里分享知识，为遇到相同问题的下一位开发者提供帮助。
优秀的 Codelab 有哪些特征？
出色的 Codelab 重点明确、易于阅读。它会明确告诉用户要构建什么、将学到什么，还会引导用户编写和理解代码，以完成特定任务。
流程
如果您对某个 Codelab 有任何想法，可以通过在 blockly-samples 代码库中发出功能请求告诉我们。添加说明，说明您要教授的内容以及您将在此 Codelab 中构建的内容。我们将讨论并完善该参考提示。 然后，您可以编写出该请求，并为其提交拉取请求。该 APK 通过审核后，Blockly 团队的成员会发布它。
书写提示
本页的其余部分包含一系列提示和问题，可指导您编写 Codelab。
查看技术写作 One，简要了解技术写作。
受众群体
- 目标读者是谁？
- 他们对使用 Blockly 有哪些了解？
- 他们想要了解什么？
初始设置
- 用户至少需要进行什么设置才能运行您的代码？
如果有帮助，您可以在 examples 目录中发布起始代码和完成后的代码。
结构
与任何写作一样，从大纲入手。对大多数 Codelab 来说，这是一个很好的结构：
- 简介
- 学习内容
- 构建内容
- 须知事项
- 设置说明
- 第一步：[请在此处添加标题]
- 说明/动机
- 代码示例
- 预期结果
- （可选）更多说明
- ...
- 第 10 步：[请在此处输入标题]
- 摘要
- 要点回顾
- 构建内容
- 其他资源
- 指向完成后的代码的链接（如果有）
虽然您可以完成 10 个以上步骤，但如果您达到 20 步，则应考虑将其拆分为两个 Codelab。
写作风格
- 采用对话式的写作风格。
- 使用标题使组织结构清晰明了。
- 使用项目符号列表打破文本的壁垒。
- 使用图片和 GIF！
代码样式
- 您可以使用 ES5、ES6 或 TypeScript 编写代码，但要告诉读取器开头是什么。
- 遵循 Google 风格指南