コンテンツにスキップ

SEC-001 必須セクション

ドキュメントに必須のセクション見出しが存在することを検証します。sections で指定した見出しのいずれかが存在しないと error になります。

ADR、要件書、設計書など同じテンプレートで書かれるべきドキュメントでも、書き手によって ## 背景## 決定事項 が抜けることがあります。AI 生成や急ぎの追記では特に起こりやすく、レビューでも見落とされがちです。このルールが見出しの欠落を機械的に検出します。

フィールド必須説明
sectionsstring[]必須とするセクション見出しテキストの配列
filesstringこのルールを適用するファイルの glob
# ADR-001 認証方式の選定
## 背景
認証方式を選定する必要がある。
## 決定事項
JWT を採用する。

sections: ["背景", "決定事項", "影響"] を設定している場合、影響 セクションが無いため違反になります。

docs/adr/001.md
line 0 error Missing required section "影響" SEC-001
# ADR-001 認証方式の選定
## 背景
認証方式を選定する必要がある。
## 決定事項
JWT を採用する。
## 影響
セッションストアが不要になる。
{
"rule": "sec001",
"options": {
"sections": ["背景", "決定事項", "影響"],
"files": "adr/*.md"
}
}

files を指定すると、ADR や要件書のように特定ディレクトリのドキュメントだけにテンプレートを強制できます。