SEC-002 章节顺序

概述

验证章节标题按 order 指定的顺序排列。order 中包含的标题以逆序出现时,会报告为 error。order 中未列出的标题会被忽略。

即便采用相同模板,撰写者也可能调换章节顺序。读者跨多份文档阅读时,如果章节顺序统一,便可以预测信息所在位置;反之则每次都需重新查找,认知成本增加。

字段	类型	必填	说明
`order`	string[]	✓	应排列顺序的章节标题数组
`level`	number	—	验证目标的标题级别(指定后会按父标题分组,各组独立验证)
`section`	string	—	指定 `level` 时,仅验证特定父标题下的内容
`files`	string	—	应用此规则的文件 glob

指定 level 后,仅提取该级别的标题进行分组,并按组验证顺序。结合 section 时,可以仅针对特定父标题下的内容。

# ADR-001

## 决策事项

采用 JWT。

## 背景

需要选择认证方式。

设置 order: ["背景", "决策事项", "影响"] 时,背景 出现在 决策事项 之后,故判定为违例。

docs/adr/001.md
  line 7  error  Section "背景" must appear before "决策事项"  SEC-002

# ADR-001

## 背景

需要选择认证方式。

## 决策事项

采用 JWT。

{
  "rule": "sec002",
  "options": {
    "order": ["背景", "决策事项", "影响"],
    "level": 2,
    "files": "adr/*.md"
  }
}