文件類型

以下簡要概述 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 儲存庫。