文档类型
以下是 amp.dev 上接受的文档贡献类型的简要概述
入门教程
入门教程帮助开发人员了解该技术的总体思路。它从编码开始，最终完成一个基本的“Hello World”项目。入门教程演示了如何以逐步方式构建 AMP 的关键功能。将入门教程与内联代码示例和/或一个可下载的示例配对，该示例只需开发人员进行最少的调整即可运行。
amp.dev 示例
| 执行 | 不要执行 |
| 提供简短的解释和最少的步骤来提供指导。 | 深入研究项目细微之处。可能有很多方法可以完成教程的结果，但重点不是展示每条路线，而是一条单一的好路线。 |
| 提供简化的环境和工具进行设置。 | 假设开发人员熟悉产品并具有专家级别的编码能力。 |
| 保持示例在视觉上简洁。 | 为了风格而复杂化，除非教程是关于样式的。 |
| 提供每个步骤和完成的演示的屏幕截图。 | 仅提供代码示例。 |
| 创建行动号召。引导开发人员接下来应该做什么。 | 将示例与进一步的解释混淆。如果您认为没有足够的后续行动，请考虑为指南或教程打开一个问题。 |
高级教程
高级教程帮助开发人员完成特定任务。它假设开发人员对 AMP 有一些了解。它应该演示如何构建体验、集成功能或解决实施任务。
amp.dev 示例
| 执行 | 不要执行 |
| 提供逐步说明和清晰的最终项目。 | 提供详尽的细节和过度阐述的概念。 |
| 提供代码示例或可下载的起始代码。此外，使最终和完整的项目可下载。 | 提供替代示例或过程以达到最终结果。 |
| 创建一个即插即用环境。 | 链接到设置教程。教程应该是独立的。 |
入门指南
入门指南提供了开始使用 AMP 的相关信息的概述。它应该识别该功能，描述它是什么，并以它做什么结束。入门指南向开发人员介绍该功能的基本要求，而无需指导他们实现它。如果您正在逐步完成一个带有代码示例的过程，那么您可能正在编写教程。如果您正在概述 AMP 组件的所有编程元素，那么您可能正在编写参考文档。
amp.dev 示例：- AMP 电子邮件基础知识 - 常用元素属性
| 执行 | 不要执行 |
| 确定文档将涵盖的内容。 | 分解为逐步过程。 |
| 介绍功能和概念。链接到参考文档以获取高级使用详细信息。 | 详细描述。 |
| 提供代码示例和真实世界示例。 | 创建一个完整的应用程序。链接到示例或演示以进行进一步探索。 |
| 列出技术用途和限制。 | 列出所有可能的技术用途以及如何完成。 |
概念指南
概念指南帮助开发人员更深入地了解 AMP。概念指南就像一张地形图。它显示了该区域的各种路径，以及海拔变化等详细信息，但它没有规定穿过地形的特定路线。解释功能是什么以及它是如何工作的，而不是如何构建功能。
amp.dev 示例
| 执行 | 不要执行 |
| 为开发人员提供构建解决方案所需的所有元素。 | 积极引导开发人员达到特定的最终状态。 |
| 涵盖主题的所有方面。 | 专注于特定任务。 |
| 包括视觉辅助工具，例如图表或屏幕截图。 | 过度考虑这一点，您可以向 [外展工作组](https://github.com/ampproject/wg-outreach) 请求视觉辅助工具方面的帮助。 |
| 提供代码示例并链接到其他指南。 | 提供已完成项目的下载或偏离主题。 |
参考文档
参考文档列出了 AMP 组件的所有编程元素。它提供了详细的行为信息，专为扫描而设计。参考文档应包括示例代码示例并演示用例。
amp.dev 参考文档可在 AMP 组件目录下找到。
AMP 参考文档贡献给 AMPHTML 存储库。
| 执行 | 不要执行 |
| 使用清晰简洁的语言解释组件的工作方式。 | 解释一个过程或构建一个项目。 |
| 使用易于扫描的标题、标题和小标题进行结构化。 | 将内容分组在抽象名称下。 |
| 提供演示组件使用的代码片段。 | 创建完整的演示应用程序。 |
-