prowler-docs

使用する場面

次のような Prowler のドキュメントを作成するときに、このスキルを使用します。

• 機能のドキュメント
• API／SDK リファレンス
• チュートリアルとガイド
• リリースノート

ブランドのトーン

偏りのないコミュニケーション

• 性別を限定する代名詞は避けます（「あなた／あなたの」または「その人／その人の」を使用します）
• 包摂的な表現を使用します。例：businessman → businessperson、mankind → humanity
• 性別、人種、国籍、文化について一般化しません
• 軍事的な表現は避けます。例：fight → address、kill chain → cyberattack chain

技術用語

• 重要な用語や頭字語は、初出時に定義します。例：「Identity and Access Management（IAM）」
• 名詞構文より動詞構文を優先します。例：「The report was created」ではなく「The creation of the report」
• 明確でわかりやすい言葉を使用し、専門用語は最小限に抑えます

書式の基準

タイトルケースでの大文字表記

すべての見出しにタイトルケースを使用します。

• 良い例：「How to Configure Security Scanning」
• 悪い例：「How to configure security scanning」

ハイフンの使用

• 名詞の前：「world-leading company」
• 名詞の後：「features built in」

箇条書き

情報を論理的に分類できる場合に使用します。

Prowler CLI includes:
* **Industry standards:** CIS, NIST 800, NIST CSF
* **Regulatory compliance:** RBI, FedRAMP, PCI-DSS
* **Privacy frameworks:** GDPR, HIPAA, FFIEC

操作を表す動詞

• デスクトップ：クリック、ダブルクリック、右クリック、ドラッグ、スクロール
• タッチ操作：タップ、ダブルタップ、長押し、スワイプ、ピンチ

SEO の最適化

文の構成

キーワードを文頭に置きます。

• 良い例：「カスタムロールを作成するには、ターミナルを開きます……」
• 悪い例：「カスタムロールを作成するために、ターミナルを開きます……」

見出し

• H1：主要な見出し（一意で、内容がわかるもの）
• H2～H6：小見出し（論理的な階層にする）
• キーワードを自然に含めます

MDX コンポーネント

バージョンバッジ

import { VersionBadge } from "/snippets/version-badge.mdx"

## New Feature Name

<VersionBadge version="4.5.0" />

Description of the feature...

警告と危険の呼び出し

<Warning>
Disabling encryption may expose sensitive data to unauthorized access.
</Warning>

<Danger>
Running this command will **permanently delete all data**.
</Danger>

Prowler の機能（固有名詞）

冠詞を付けずに記載します。

• Prowler App、Prowler CLI、Prowler SDK
• Prowler Cloud、Prowler Studio、Prowler Registry
• Built-in Compliance Checks
• Multi-cloud Security Scanning
• Autonomous Cloud Security Analyst（AI）

ドキュメントの構成

docs/
├── getting-started/
├── tutorials/
├── providers/
│   ├── aws/
│   ├── azure/
│   ├── gcp/
│   └── ...
├── api/
├── sdk/
├── compliance/
└── developer-guide/

リソース

• ドキュメント：ローカルの開発者ガイドへのリンクについては、references/ を参照してください