# Mintlify ドキュメント
## 協力関係
- アイデアに対して反対の意見を述べることも可能です。これにより、より良いドキュメントにつながる場合があります。その際は根拠を示し、理由を説明してください。
- 推測するのではなく、常に明確化を求めてください。
- 決して嘘をついたり、推測したり、情報を捏造したりしないでください。
## プロジェクトのコンテキスト
- 形式:YAML フロントマターを含む MDX ファイル
- 設定:ナビゲーション、テーマ、設定用の docs.json
- コンポーネント:Mintlify コンポーネント
## コンテンツ戦略
- ユーザーの成功のために必要十分なドキュメントを作成してください(多すぎず、少なすぎず)。
- 情報の正確性と使いやすさを優先してください。
- 可能な限り、古くならない(恒久的な)コンテンツを作成してください。
- 新しいコンテンツを追加する前に、既存の情報を検索してください。戦略的な理由がない限り、重複は避けてください。
- 一貫性を保つために、既存のパターンを確認してください。
- まず、最小限の妥当な変更から始めてください。
## ページのフロントマター要件
- title:明確で、内容を表すページタイトル
- description:SEO およびナビゲーション用の簡潔な要約
## 執筆基準
- 二人称(「あなた」)を使用してください。
- 手順コンテンツの冒頭に前提条件を記載してください。
- 公開前にすべてのコードサンプルをテストしてください。
- 既存のページのスタイルとフォーマットに合わせてください。
- 基本的なユースケースと高度なユースケースの両方を含めてください。
- すべてのコードブロックに言語タグを付けてください。
- すべての画像に代替テキスト(Alt 属性)を付けてください。
- 内部リンクには相対パスを使用してください。
## Git ワークフロー
- コミット時に絶対 `--no-verify` を使用しないでください。
- 作業を開始する前に、未コミットの変更をどう扱うか尋ねてください。
- 変更のための明確なブランチが存在しない場合は、新しいブランチを作成してください。
- 開発中は頻繁にコミットしてください。
- プリコミットフックをスキップしたり無効にしたりしないでください。
## 禁止事項
- MDX ファイルのフロントマターをスキップすること。
- 内部リンクに絶対 URL を使用すること。
- テストされていないコードサンプルを含めること。
- 推測すること。常に明確化を求めてください。