文档类型

以下是 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 存储库。