

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 建立 的 AMI 和容器產品使用說明 AWS Marketplace
<a name="ami-container-product-usage-instructions"></a>

身為 AWS Marketplace 賣方，您會以不同的方式將產品交付給買方。使用 Amazon Machine Image (AMIs) 和容器映像交付時，您需負責為其撰寫使用說明。下列各節提供撰寫這些產品類型使用說明的要求和建議。

如需詳細資訊，請參閱[中的 AMI 型產品 AWS Marketplace](ami-products.md)。

**Topics**
+ [需求](#ami-write-usage-instructions)
+ [撰寫版本備註](#writing-the-release-notes)
+ [撰寫使用說明](#writing-the-usage-instructions)
+ [撰寫升級指示](#writing-upgrade-instructions)
+ [撰寫 CloudFormation 交付指示](#ami-cloudformation-delivery)

## 需求
<a name="ami-write-usage-instructions"></a>

為產品建立使用說明時，您必須包含下列資訊：
+ 客戶儲存的所有敏感資訊的位置。
+ 說明所有資料加密組態。如果您的應用程式使用任何加密技術，請提供使用者如何與您的應用程式互動以解密必要資料的詳細說明。
+ 如果您的產品包含密碼編譯材料，您必須在使用說明中包含輪換要求。如需使用登入資料和密碼編譯金鑰的清單[的 AMI 型產品需求 AWS Marketplace](product-and-ami-policies.md)基本需求，請參閱 。
+ 如果產品中的任何資料存放區為專屬，請提供組態、備份和復原的step-by-step說明。
+ 如何評估和監控應用程式運作狀態和適當功能的Step-by-step說明。例如：
  + 導覽至 [Amazon EC2 主控台](https://us-east-1.signin.aws.amazon.com/oauth?response_type=code&client_id=arn%3Aaws%3Aiam%3A%3A015428540659%3Auser%2Fec2&redirect_uri=https%3A%2F%2Fus-east-1.console.aws.amazon.com%2Fec2%2Fv2%2Fhome%3Fregion%3Dus-east-1%26state%3DhashArgs%2523Home%253A%26isauthcode%3Dtrue&forceMobileLayout=0&forceMobileApp=0&code_challenge=aRqwDZ0gdWGXfWQgSpY_ge8vSRw2poGnBZ_8qsU5fiA&code_challenge_method=SHA-256)，並驗證您位於正確的區域。
  + 選擇**執行個體**，然後選取您啟動的執行個體。
  + 選取要顯示中繼資料頁面的伺服器，然後選擇頁面底部的**狀態檢查**索引標籤，以檢閱您的狀態檢查是否通過或失敗。
+ 管理 AWS 服務配額的規範性指引。如需詳細資訊，請參閱 [AWS 一般參考指南](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html)。
+ 定價明細，包括超出標準配額的執行 AWS 資源成本。這可以包含在產品使用說明中，或連結到[文件](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html)，其中包含有關管理和請求增加服務配額的詳細資訊。

## 撰寫版本備註
<a name="writing-the-release-notes"></a>

每次更新產品時，您必須提供版本備註中變更的說明。版本備註應包含特定資訊，以協助使用者決定是否要安裝更新。使用清晰的標籤進行更新，例如「關鍵」進行安全性更新，或「重要」或「選用」進行其他類型的更新。

## 撰寫使用說明
<a name="writing-the-usage-instructions"></a>

提供使用說明，以協助確保買方可以成功設定和執行軟體。您提供的使用說明會在組態程序期間顯示。

若要撰寫有效的使用說明，請遵循下列準則：
+ 假設使用者感興趣但沒有資訊。
+ 提供使用者啟動和使用您的產品所需的所有資訊，包括任何組態設定和特殊步驟。

 範例使用說明：

1. 使用 1-Click 啟動產品。

1. 使用 Web 瀏覽器在 存取應用程式`https://<EC2_Instance_Public_DNS>/index.html`。

1. 使用下列登入資料登入：
   + 使用者名稱： `user`
   + 密碼：執行個體 ID (`instance_id`)

## 撰寫升級指示
<a name="writing-upgrade-instructions"></a>

提供買方如何從舊版產品升級的詳細資訊。包含有關如何在建立另一個執行個體時保留資料和設定的資訊。如果沒有升級路徑，請編輯此欄位以特別提及。

升級指示範例：

1. 執行 \*\*\*\*，然後執行 \*\*\*\*。

1. 透過執行 \*\*\*，檢查專案使用的所有外掛程式是否與版本 \*.\* 相容。如果不相容，請執行 \*\*\*。

1. 透過執行 \*\*\* 來備份您的資料。

## 撰寫 CloudFormation 交付指示
<a name="ami-cloudformation-delivery"></a>

使用 CloudFormation 交付時，您還必須包含下列項目：
+ 範本建立的每個 AWS Identity and Access Management (IAM) 角色和 IAM CloudFormation 政策的用途
+  CloudFormation 範本所建立之每個金鑰的用途和位置
+ 部署中涉及多個元素的網路組態詳細資訊
+ 有關如何啟動應用程式，以及部署是否包含多個 AWS 資源時如何設定通訊的詳細指南
+ 定價明細，包含執行超過標準限制之新增 AWS 資源的成本。提供管理 AWS 服務限制的規範性指引。
+ 所有資料加密組態。例如：Amazon S3 伺服器端加密、Amazon Elastic Block Store (Amazon EBS) 加密、Linux 統一金鑰設定 (LUKS) 等）