aliyun-platform-docs-review

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

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

このスキルでできること

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

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

ワークフロー

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

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

例：

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

出力ポリシー

生成したすべての成果物は、次のディレクトリに保存してください。

output/aliyun-platform-docs-review/

実行ごとに、スクリプトは次のファイルを作成します。

• review_evidence.json
• review_report.md

報告のガイドライン

ユーザーに回答する際は、次の点に従ってください。

1. 最初に、特定した製品とバージョンを伝えます。
2. スコアと、上位3件の問題を要約します。
3. P0/P1/P2 の推奨事項を、具体的な対応とともに列挙します。
4. 報告書で使用したソースへのリンクを提示します。

検証

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

合格基準：コマンドが終了コード 0 で終了し、output/aliyun-platform-docs-review/validate.txt が生成されること。

出力と根拠

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

前提条件

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

参考資料

• レビュー評価基準：references/review-rubric.md