# Mintlify テクニカルライティングルール
## プロジェクトのコンテキスト
- これは Mintlify プラットフォーム上のドキュメントプロジェクトです
- YAML フロントマターを含む MDX ファイルを使用します
- ナビゲーションは `docs.json` で設定されます
- テクニカルライティングのベストプラクティスに従います
## 執筆基準
- 指示には二人称（「あなた」）を使用してください
- 能動態かつ現在形で書いてください
- 手順は前提条件から始めてください
- 主要なステップに対して期待される結果を含めてください
- 説明的でキーワードが豊富な見出しを使用してください
- 文章は簡潔でありながら情報が豊富になるようにしてください
## 必須のページ構成
すべてのページはフロントマターから始める必要があります：
```yaml
---
title: "明確で具体的なタイトル"
description: "SEO とナビゲーション用の簡潔な説明文"
---
```
## Mintlify コンポーネント
### コールアウト
- `<Note>`：役立つ補足情報
- `<Warning>`：重要な注意事項や重大な変更
- `<Tip>`：ベストプラクティスや専門的なアドバイス
- `<Info>`：中立的なコンテキスト情報
- `<Check>`：成功の確認
### コードサンプル
- 適切な場合は、完全で実行可能な例を含めてください
- 複数言語の例には `<CodeGroup>` を使用してください
- すべてのコードブロックに言語タグを指定してください
- プレーホルダーではなく、現実的なデータを含めてください
- API ドキュメントには `<RequestExample>` と `<ResponseExample>` を使用してください
### 手順
- 順を追った指示には `<Steps>` コンポーネントを使用してください
- 関連する場合は、`<Check>` コンポーネントによる検証ステップを含めてください
- 複雑な手順はより小さなステップに分割してください
### コンテンツの整理
- プラットフォーム固有のコンテンツには `<Tabs>` を使用してください
- 段階的な開示には `<Accordion>` を使用してください
- コンテンツの強調には `<Card>` と `<CardGroup>` を使用してください
- 画像は説明的な代替テキストを付けて `<Frame>` コンポーネントでラップしてください
## API ドキュメントの要件
- すべてのパラメータを `<ParamField>` でドキュメント化してください
- レスポンス構造を `<ResponseField>` で示してください
- 成功とエラーの両方の例を含めてください
- ネストされたオブジェクトプロパティには `<Expandable>` を使用してください
- 常に認証の例を含めてください
## 品質基準
- 公開前にすべてのコードサンプルをテストしてください
- 内部リンクには相対パスを使用してください
- すべての画像に代替テキストを含めてください
- 適切な見出し階層（h2 から開始）を確保してください
- 一貫性を保つために、既存のパターンを確認してください
