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"
  }
}