이 디렉터리는 외부 사용자에게 공개할 문서 원천과 최소 표준 문서만 보관한다.
릴리스 과정, 검토 루프, 과거 판단 기록은 공개 사용자가 알아야 할 내용이
아니므로 active docs와 섞지 않고 archive/v1/docs로 분리한다.
docs
|-- changelog.md # 사용자 영향 중심 변경 기록
|-- generated
| `-- repo-catalog.json # v3 Core와 optional companion catalog
|-- issues
| `-- 245-concept-dictionary-naming-ssot.md # issue #245 raw 실행 계약
|-- public
| |-- overview.md # 프로젝트 이해
| |-- quickstart.md # 사용 시작
| `-- api.md # 공개 API
`-- standard
|-- concept-and-naming-standard.md # 전체 repository 개념·이름 정본
|-- v3-json-document-profile.md # 현재 v3 root compatibility profile
`-- v3-public-surface.json # v3 공개 binding1.x public 문서, 표준, 기능 taxonomy 연구 기록은 코드와 함께
archive/v1/docs에 보존합니다. Archive는 현재 package, 공개 사이트,
generated catalog의 입력이 아닙니다.
Repository 전체의 개념과 이름 정본은
concept-and-naming-standard.md입니다. 현재 v3 portable root의 compatibility
정본은 v3-json-document-profile.md, v3-public-surface.json, 그리고 profile이
지정한 conformance vector와 language binding입니다. 이름 정본은 stable v3
identifier나 동작을 바꾸지 않으며, Archive의 1.x 문서는 v3 exact
20-symbol·six-member 계약을 확장하지 않습니다.
| 위치 | 책임 | 독자 |
|---|---|---|
changelog.md |
사용자 영향 중심 변경 기록 | 외부 사용자, 릴리스 확인자 |
generated/ |
v3 Core와 명시적으로 등록한 companion 표면으로 만든 reference data. 직접 편집하지 않는다. | evaluator |
issues/ |
Context recovery를 위해 보존한 issue raw 실행 계약. Concept authority는 아니다. | maintainer, 실행 agent |
public/ |
사용법과 프로젝트 이해를 위한 공식 문서 원천 | 외부 사용자, LLM, 사이트 방문자 |
standard/ |
Repository 개념·이름 정본과 v3 root compatibility 정본 | 표준화 검토자, 대체 구현 작성자 |
- 본문은 한글로 쓴다.
- 코드 식별자, 명령어, 파일 경로, 표준명은 원문을 유지한다.
- public 문서는 usage와 프로젝트 이해만 다룬다.
- 릴리스 history, 검토 loop, maintainer-only gate는 public 문서에 쓰지 않는다.
- 내부 구현 경로는 public 문서에 쓰지 않는다.
- generated catalog는 Core와 두 collaboration companion의 exact 경로만 읽으며 archive, app, 그 밖의 sibling package를 active package로 추론하지 않는다.
- 새 문서는 기존 책임 폴더 중 하나에 들어가야 한다.
- 새 책임 폴더가 필요하면 먼저 이 파일의 책임 표를 갱신한다.
- 새 public concept와 이름은
standard/concept-and-naming-standard.md의 admission과 문법을 먼저 통과해야 한다.