openapi-mcp markdown.instructions.md

Markdownファイル作成・編集指針

コーディング規約

以下のルールは必ず遵守してください。 違反が見つかった場合は即座に修正が必要です。

インデントルール

• スペースインデント使用(タブ禁止)
• インデントは4スペース固定(2スペースは不可)

見出しルール

基本ルール

• h1はドキュメント内で1つのみ
• 見出しレベルは段階的に増やす(h1→h2→h3、レベルスキップ禁止)
  • 見出しレベルは一度に1段階以上増加させてはいけない
  • 正: h1 → h2 → h3 → h4
  • 誤: h1 → h3 (h2をスキップ)
  • h2の直下はh3から開始し、必要に応じてh4以降へ段階的に増やす
  • h2の直下にh4を置かない
• 見出しの前後に空行を1行入れる

見出しレベル別の記法

• h1: 見出し文 + 下線(===== 長さ25文字固定)
• h2: 見出し文 + 下線(----- 長さ25文字固定)
• h3: ### 見出し文
• h4: #### 見出し文
• h5: ##### 見出し文
• h6: ###### 見出し文

見出しの表記ルール

【重要】見出しは見出し記法で記述します

• 見出しは必ずh1〜h6の見出し記法で記述します
  • OK例: ##### 詳細項目 (適切なh5見出し)
  • NG例1: **詳細項目** (h5/h6相当の内容を太字で表現)
  • NG例2: * **小見出し**: 説明文 (リスト内で太字を見出し代わりに使用)
  • NG例3: **小見出し** (本文の太字だけで見出しに見せる)
• 見出しの代用として太字のみの行を置きません
• 見出しが6レベルを超える場合は構造を見直します
• 太字による見出し代用を発見した場合の修正方法
  • 適切な見出しレベル(h3〜h6)に変換する
  • 見出しレベルは直前の見出しレベル+1を基準とする
  • 末尾のコロン(:)がある場合は削除する
  • 修正例: **見出し:** → ### 見出し (直前がh2の場合)

平文化された見出し候補の扱い

• 太字禁止の適用時に、見出し候補を通常文へ平文化しません
• 次の条件を満たす単独行は、太字除去ではなく見出し記法へ変換します
  • 20文字以内の短いラベル
  • 文末が句点(。)で終わらない
  • 直後に段落、リスト、表、コードブロックのいずれかが続く
• 変換時は直前見出しレベル+1を基準にh3〜h6を選択します
• 修正例: 実装手順 → ##### 実装手順
• 修正例: 前提条件 → ##### 前提条件

太字使用ルール(限定的に使用)

原則: 太字は極めて限定的にのみ使用します

• 本ルールの主目的は、LLMの注意配分を安定させることです。

• 項目名の常時太字化は重要度の差分を失わせ、生成時のアテンションを乱しやすいため禁止します。

• 使用可能な場合(以下のみ使用します)

  • **注意**:, **警告**:, **重要**: で始まる警告文の接頭辞のみ
  • **必須**:, **禁止**: または **<行動指示>必須**:, **<行動指示>禁止**: で始まる行動指示の接頭辞のみ
    • OK例: * **必須**: 設定を行う
    • OK例: * コミット禁止: git commitは実行しない
  • 本文中の重要語句の強調(意味解釈に必要な語句のみ)
    • 1文中は1箇所以内、1段落中は2箇所以内を推奨
    • 太字を外しても意味が変わらない場合は装飾目的とみなす
  • ルール説明文中の重要な制約事項(例: 「h1はドキュメント内で1つのみ」)

• 太字を使用しない例

  • NG例: * **項目名**: 説明文 (装飾目的)

• 違反例と修正例

  • NG: **実装手順** → OK: ##### 実装手順
  • NG: * **設定項目**: 詳細説明 → OK: * 設定項目: 詳細説明
  • NG: **ここに注意** → OK: **注意**: ここに注意 または 注意: ここに注意