Living Docs
문서를 코드와 동기화된 살아있는 시스템으로 취급하고, 한 번 작성하면 썩어가는 고정된 산출물이 아닌 것으로 관리합니다. 이 규율은 하나의 핵심 원칙(모든 지식은 정확히 하나의 저장소를 가지며, 그 저장소는 색인되어야 하고, 구조적 변경은 문서 없이 이루어질 수 없다)과 그에 따라 구성된 여러 문서 유형(헌법, ADR, BDR, PRD, 이슈, 연구, 아키텍처 다이어그램, 의미론적 컨텍스트 색인)으로 구성됩니다.
이 스킬은 스택에 구애받지 않습니다. 문서가 어떻게 구성되고 유지되는지만 규율하며, 프로젝트가 사용하는 기술은 절대 규정하지 않습니다.
핵심 불변 규칙 (척추)
이 규칙들은 모든 문서 유형에 걸쳐 적용됩니다. 다른 모든 것은 세부 사항입니다.
- 문서 우선. 본문은 저장소(
docs/...)에서 먼저 작성하고, 그 후에 외부(트래커, 위키)에 게시합니다. 저장소 파일이 진실의 원천(source of truth)이며, 외부 사본은 미러입니다. - 사실 당 하나의 저장소. 각 개념, 결정, 요구사항은 정확히 하나의 파일에 있습니다. 중복 없음 — 복사 대신 상호 참조합니다. 중복된 문장은 곧 발생할 표류(생략)입니다.
- 색인되지 않으면 존재하지 않음. 모든 문서는 색인(해당 디렉터리의
index.md목록과 프로젝트 가이드가 연결하는 번들 루트docs/index.md)을 통해 접근 가능해야 합니다. 고아 파일은 없습니다. - 과거를 다시 쓰지 않고 대체(supersede)함. 결정과 요구사항은 추가 전용 기록입니다. 무언가 변경되면 이전 기록을 대체(superseded)로 표시하고 새 기록을 작성합니다. 과거를 조용히 편집하지 마십시오.
- 문서 없는 구조적 변경은 없음. 새 모듈, 파일 이동, 스키마 변경, 새 데이터 흐름 → 동일한 변경 내에서 관련 문서 및 다이어그램을 업데이트합니다.