alicloud-platform-docs-api-review

Alibaba Cloud 製品ドキュメント + API ドキュメントレビュアー

ユーザーが製品名を提示し、ドキュメントと API のエンドツーエンド品質レビューを依頼した場合に、このスキルを使用します。

このスキルでできること

1. 最新の OpenAPI メタデータから製品を特定します。
2. デフォルトバージョンの最新 API ドキュメントを取得します。
3. 公式製品ページから製品およびヘルプドキュメントへのリンクを見つけます。
4. 以下を含む構造化されたレビューレポートを作成します。

• スコア
• 根拠
• 優先度別の提案（P0/P1/P2）

ワークフロー

同梱のスクリプトを実行します。

python skills/platform/docs/alicloud-platform-docs-api-review/scripts/review_product_docs_and_api.py --product "<product name or product code>"

例：

python skills/platform/docs/alicloud-platform-docs-api-review/scripts/review_product_docs_and_api.py --product "ECS"

出力ポリシー

生成されるすべての成果物は、次のディレクトリに保存する必要があります。

output/alicloud-platform-docs-api-review/

実行ごとに、スクリプトは以下を作成します。

• review_evidence.json
• review_report.md

レポート作成のガイダンス

ユーザーへの回答では、以下のようにします。

1. 最初に、特定した製品とバージョンを示します。
2. スコアと主な問題点を3つ要約します。
3. 具体的な対応策とともに、P0/P1/P2 の推奨事項を列挙します。
4. レポートで使用した参照リンクを提示します。

検証

mkdir -p output/alicloud-platform-docs-api-review
for f in skills/platform/docs/alicloud-platform-docs-api-review/scripts/*.py; do
  python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/alicloud-platform-docs-api-review/validate.txt

合格基準：コマンドが 0 を返し、output/alicloud-platform-docs-api-review/validate.txt が生成されること。

出力と根拠

• 成果物、コマンド出力、API レスポンスの要約を output/alicloud-platform-docs-api-review/ に保存します。
• 再現性を確保するため、根拠ファイルには主要なパラメーター（リージョン／リソース ID／期間）を含めます。

前提条件

• 実行前に、最小権限の Alibaba Cloud 認証情報を設定します。
• 環境変数を使用することを推奨します：ALICLOUD_ACCESS_KEY_ID、ALICLOUD_ACCESS_KEY_SECRET、任意の ALICLOUD_REGION_ID。
• リージョンが不明な場合、変更を伴う操作を実行する前にユーザーに確認します。

参照資料

• レビュールーブリック：references/review-rubric.md