SEC-001 必需章节

概述

验证文档中存在必需的章节标题。sections 中指定的任何标题缺失时,会报告为 error。

为什么需要

ADR、需求文档、设计文档等本应基于同一模板的文档,根据撰写者的不同,仍可能漏掉 ## 背景 或 ## 决策事项。AI 生成或仓促补写时尤其容易发生,在评审中也常被忽略。本规则可机械化检测标题缺失。

选项

字段	类型	必填	说明
sections	string[]	✓	必需章节标题文本的数组
files	string	—	应用此规则的文件 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 或需求文档。

相关规则

• SEC-002 章节顺序 — 在必需章节存在的基础上,验证排列顺序
• STR-001 文件存在 — 验证必需的文件本身是否存在