文档类型

以下简要概述了 amp.dev 上接受的文档贡献类型

入门教程

入门教程帮助开发者理解该技术的总体思路。它从编码开始，以一个完整的 “Hello World” 基本项目结束。入门教程演示如何通过逐步流程构建 AMP 的关键功能。将入门教程与内联代码示例和/或可下载的示例配对，这些示例只需要开发者进行最少的调整即可运行。

amp.dev 示例

应该做	不应该做
提供简要解释和最少步骤的指导。	深入探讨项目细微之处。可能有很多方法可以完成教程的结果，但重点不是展示每条路线，而是一条单一的，好的路线。
提供简化的环境和设置工具。	假设开发者熟悉产品并且具有专家级的编码能力。
使示例在视觉上保持简洁。	为了风格而复杂化，除非本教程是关于样式设置的。
提供每个步骤和完成演示的屏幕截图。	仅提供代码示例。
创建号召性用语。指示开发者接下来应该做什么。	将示例与进一步的解释混淆。如果您觉得没有足够的后续步骤，请考虑为指南或教程提出问题。

高级教程帮助开发者完成特定任务。它假设开发者对 AMP 有一定的了解。它应演示如何构建体验，集成功能或解决实施任务。

amp.dev 示例

应该做	不应该做
提供带有明确最终项目的逐步说明。	提供详尽的细节并过度阐述概念。
提供代码示例或可下载的入门代码。此外，使最终的完整项目可下载。	提供替代示例或过程以达到最终结果。
创建一个即插即用的环境。	链接到设置教程。教程应是独立的。

入门指南概述了开始使用 AMP 的相关信息。它应该确定功能，描述它的内容，最后描述它的作用。入门指南向开发者介绍该功能的基本要求，而无需指导他们实施它。如果您正在逐步介绍带有代码示例的过程，则您可能正在编写教程。如果您概述了 AMP 组件的所有编程元素，则您可能正在编写参考文档。

应该做	不应该做
确定文档将涵盖的内容。	分解为逐步过程。
介绍功能和概念。链接到参考文档以获取高级用法详细信息。	详细描述。
提供代码示例和实际示例。	创建一个完整的应用程序。链接到示例或演示以进行进一步探索。
列出技术用途和限制。	列出每种可能的技术用途以及如何完成。

概念指南帮助开发者更深入地了解 AMP。概念指南就像地形图。它显示了该区域的各种路径，并详细说明了诸如海拔变化之类的详细信息，但并未规定穿越地形的特定路线。解释功能是什么及其工作原理，而不是如何构建功能。

amp.dev 示例

应该做	不应该做
向开发者提供构建解决方案所需的所有元素。	积极指导开发者达到特定的最终状态。
涵盖主题的所有方面。	专注于特定任务。
包括视觉辅助工具，例如图表或屏幕截图。	过度考虑这一点，您可以从 [外展工作组](https://github.com/ampproject/wg-outreach) 请求视觉辅助工具的帮助。
提供代码示例并链接到其他指南。	提供已完成项目的下载或偏离主题。

参考文档列出了 AMP 组件的所有编程元素。它提供详细的行为信息，并且专为扫描而设计。参考文档应包括示例性代码示例并演示用例。

amp.dev 参考文档可在 AMP 组件目录下找到。

AMP 参考文档已贡献给 AMPHTML 存储库。