docs: 별도 repo 라이브러리로서의 지침·작업 문서·릴리스 절차를 쓴다
pr / ci (pull_request) Successful in 1m9s

옮겨 온 문서는 템플릿 안의 optional build를 전제로 했다(`-p
platforms/optional-build`, 템플릿 registry·workflow 경로, "벤더드 플랫폼").
하네스 뼈대의 루트 지침과 문제 정의는 비어 있었다.

- 루트 AGENTS.md(38줄)·CLAUDE.md: 꼭 지킬 것(core-api 순수성, Stable이
  advanced를 안 씀, 템플릿에 기대지 않음, 배포한 버전 불변, 버전 규칙),
  지도, 맡은 일, 검증 진입점. 비대화형 세션의 플러그인 설치 두 줄.
- README: 무엇인가, 받는 법(exclusiveContent), 지원 표, 구조, 문서 지도,
  서명, 이력(filter-repo, 커밋 SHA·리뷰 ID는 템플릿 기준).
- docs/work/README.md·gates.md·release.md: 고치는 법, 단계와 바꾼 것별
  게이트, 템플릿과 같이 고치기(composite), 릴리스와 소유자가 할 일
  (PACKAGES_TOKEN, SIGNING_KEY·SIGNING_PASSWORD, 첫 태그 v1.0.0).
- CHANGELOG.md(1.0.0 미발행, 옮기는 법), docs/README.md(지도, 머리 블록).
- scripts/verify.sh: unit·pr·main·release 단계. 라이브러리라 app은 없다.
- 살아 있는 문서(grpc·grpc-advanced AGENTS.md, 지원 매트릭스, runbook):
  경로·패키지·optional build 문장을 이 repo 기준으로. ADR·설계서 본문은
  기록이라 고치지 않았다.
- docs/vision.md는 소유자가 쓰는 문서라 비워 두었다.

검증: scripts/verify.sh docs rc=0(AGENTS.md 38줄, 장부 JSON).
This commit is contained in:
DongHyeonka
2026-11-08 11:22:12 +09:00
parent 8d705bcaaf
commit ce83f4d550
15 changed files with 382 additions and 98 deletions
+30
View File
@@ -0,0 +1,30 @@
# 문서 지도
## 1. 어디에 무엇이 있나
| 폴더 | 종류 | 고치는 법 |
| --- | --- | --- |
| `work/` | 작업 방법(고치기, 게이트, 릴리스) | 살아 있는 문서. 동작이 바뀌면 같은 변경에서 고친다 |
| `compatibility/` | 지원 매트릭스(무엇을 인증했나) | 살아 있는 문서 |
| `runbooks/` | 운영 대응 | 살아 있는 문서 |
| `adr/` | 결정 기록(ADR-GRPC-*) | 기록. 본문은 고치지 않는다 |
| `design/` | 설계서 | 기록. 본문은 고치지 않는다 |
| `ledger/` | 예측·실측 장부 | 줄을 더하기만 한다 |
| `vision.md`, `problem-statement.md` | 방향, 풀 문제 | `vision.md`는 소유자만 쓴다 |
## 2. 기록 문서의 머리 블록
`adr/`와 `design/`의 문서는 맨 위에 머리 블록을 둔다. 본문은 쓴 때의 원문이고, 지금도 맞는지는 머리 블록이 말한다.
```markdown
<!-- 머리 블록: 이 블록을 빼면 원문이다. 형식은 docs/README.md 「기록 문서의 머리 블록」 -->
> **결정 기록** 본문은 결정한 때의 내용이다. 지금도 유효한지는 「상태」를, 지금 동작은 「현재 정본」을 읽는다.
- 상태: 채택 | 대체됨(무엇으로) | 폐기
- 작성일: YYYY-MM-DD
- 요약: 한 문장
- 현재 정본: 지금 동작을 설명하는 살아 있는 문서 경로
<!-- 머리 블록 끝 -->
```
지난 결정이 바뀌면 본문은 두고 「상태」와 「현재 정본」만 고친다. 템플릿에서 옮겨 온 기록의 본문 경로(`src/platforms/…`, `.github/workflows/…`)는 그 결정 때의 템플릿 경로다.