docs-system — v1.0.0
모든 리포지토리에 완전한 문서화 시스템을 설치하고 유지 관리합니다. 프로젝트 문서를 체계화, 분류, 인덱싱 및 동기화해야 하거나, "문서화 시스템 / 문서 분류 체계 / 문서 편람을 설정"하라는 요청을 받았을 때 이 스킬을 사용하세요.
이 스킬은 네 가지 스크립트(scripts/ 폴더에 있음)로 구현되며, 순서대로 호출합니다. 모든 스크립트는 멱등적이며 기록을 보존합니다(git mv). 마이그레이션은 검토 후 적용됩니다(먼저 --dry-run 실행).
사용 시기
- 리포지토리에 분류되지 않은 문서가 많이 있음 → 시스템을 설치하고 마이그레이션합니다.
- 문서를 생성/편집함 → 해당 폴더의 편람을 재생성합니다(필수 단계).
- 문서 인덱스/용어집/"MEMORIAL"/분류 체계를 요청받음.
명령어 (스크립트)
| 명령어 | 스크립트 | 목적 |
|---|---|---|
| bootstrap | scripts/docs-bootstrap.sh <repo> | 킷 설치: 카테고리 폴더 스캐폴딩, 거버넌스 문서(분류 체계/템플릿/빠른 시작/레지스트리/용어집) 복사, 4개 스크립트 설치, 에이전트 파일에 문서 규칙 추가. 멱등적. |
| migrate | `scripts/docs-migrate.sh [--dry-run | --apply] ` |
| compile | scripts/docs-compile.sh <folder> | <folder>/MEMORIAL.md (재)빌드 — 날짜 순서의 모든 문서 편람 + 인덱스 + 용어집 링크 + 전체 본문. 결정론적 재빌드: 멱등성 / 자동 추가 / 중복 제거 / 재정렬. --clean <folder>는 편람을 제거함. |
| append | scripts/docs-append.sh <doc> ["summary"] | 문서에 대한 링크 한 줄을 해당 폴더 README.md 인덱스에 추가함(멱등적). |
표준 워크플로우
# 1. 설정 (리포지토리당 한 번)
cp docs-system.conf.example .docs-system.conf # PROJECT_NAME, AGENT_RULES, PLAN_BUCKET 편집
# 2. 설치
scripts/docs-bootstrap.sh .
# 3. 기존 문서 마이그레이션 — 먼저 DRY-RUN 실행, 검토 후 적용
scripts/docs-migrate.sh --dry-run .
scripts/docs-migrate.sh --apply .
# 4. 편람 빌드
for d in documentation features testing reviews changes PLANS; do
scripts/docs-compile.sh "docs/$d"
done
# 5. 마무리: docs/documentation/DOCUMENTATION-REGISTRY.md 재시딩, GLOSSARY.md 프로젝트 용어 편집
필수 지속 규칙
docs/<folder>/ 아래에 문서를 생성하거나 편집한 후에는 반드시
scripts/docs-compile.sh docs/<folder>를 실행하고 재생성된 MEMORIAL.md를 문서와 함께 커밋하세요.
MEMORIAL.md를 수동 편집하지 마십시오(생성된 파일입니다). 이 규칙은 bootstrap에 의해 대상 리포지토리의 에이전트 규칙 파일에도 작성됩니다.
문서 헤더 마커 (강제)
모든 .md 파일은 H1 아래에 다음을 포함해야 합니다:
<!-- version --> · <!-- classification: TYPE --> · <!-- date --> · <!-- last-updated -->.
date는 생성 시 한 번 설정되며, last-updated만 편집 시 변경됩니다. 유형:
FEATURE / TESTING / DESIGN / GAPS / ANALYSIS / CHANGE / STUDY / REVIEW / ARCHITECTURE / SUMMARY / PLAN.
안전 / 되돌리기
docs-migrate.sh는 기본적으로--dry-run입니다.--apply전에 표를 검토하세요.- 편람 되돌리기:
scripts/docs-compile.sh --clean docs/<folder>또는find docs -name MEMORIAL.md -delete. - 모든 것이 git 추적됨;
git revert로 실행을 취소할 수 있습니다. 이동은 이름 변경(기록 보존)입니다.
참조
references/PLAYBOOK.md— 전체 절차, 구성 옵션, 검증, 되돌리기.