이 디렉터리는 공개 후보 문서와 관리 문서를 나누어 보관합니다.
처음 읽는 사람은 docs/views/만 보면 됩니다. docs/workbench/는 설계 메모, 검토 자료, 과거 source를 모아 둔 관리 영역입니다.
문서 생성과 동기화 기준은 docs/_harness/doc-map.yml에 있습니다.
이 파일은 사람이 읽는 문서가 아니라, 어떤 source에서 어떤 view를 만들었는지 추적하는 관리 파일입니다.
| Path | 역할 | Publish |
|---|---|---|
views/ |
사람이 읽는 공개 후보 문서 | Yes |
assets/ |
roadmap, architecture, schema, metrics, decision, safety diagram | Yes |
dashboards/ |
milestone 진행 상황을 보여주는 HTML dashboard | Link or embed |
_harness/ |
source mapping과 publish boundary 관리 | No |
workbench/ |
specs, plans, ADRs, source context | No |
reference/ |
보조 참고 자료 | No by default |
- 프로젝트 개요와 추진 전략
- 시스템 구조와 실행 환경
- 소스 스캔 결과 NoSQL Schema
- 탐지 결과와 지표
- Local Scan Orchestration 구조
- 시작하기
- progress dashboard
| 문서 | 읽으면 알 수 있는 것 |
|---|---|
| project-overview-and-strategy.md | 이 프로젝트가 해결하려는 문제, 현재 지원 범위, 성공 기준 |
| system-architecture-and-runtime.md | 전체 구조, 실행 흐름, codebase dependency boundary |
| source-scan-results-nosql-schema.md | 스캔 결과를 어떻게 저장하고 어떤 질문에 답하려는지 |
| secret-detection-results-and-metrics.md | 어떤 결과를 공개할 수 있고, 지표를 어떻게 해석하는지 |
| local-scan-orchestration-target-architecture.md | Local Scan Orchestration의 Python file 참조 관계와 runtime call chain |
| operations-transition-architecture.md | 로컬 실행 경로에서 반복 실행과 확장 adapter로 넘어가는 기준 |
| research-and-technical-decisions.md | 왜 Gitleaks-first인지, 다른 도구는 어떤 위치인지 |
| getting-started.md | 이미 클론된 로컬 저장소로 첫 스캔을 끝까지 돌리는 절차 |
| public-repo-safety-policy.md | 공개 저장소에 쓰면 안 되는 것과 커밋 전 확인 기준 |
- supported-workflow-map.svg
- system-architecture.svg
- runtime-flow.svg
- codebase-architecture.svg
- local-scan-target-codebase-structure.svg
- local-scan-target-file-references.svg
- local-scan-target-runtime-flow.svg
- local-scan-target-scenario-seams.svg
- schema-access-patterns.svg
- metrics-flow.svg
- operations-transition.svg
- decision-matrix.svg
- safety-publish-flow.svg
docs/views/*.md에는 사람이 읽을 제목과 본문만 둡니다.
generated_by, generated_at, source_docs, source_hashes 같은 관리 정보는 docs/_harness/doc-map.yml에만 둡니다.
workbench/는 publish 대상이 아닌 관리 영역입니다.
Legacy source는 workbench/context/legacy-source/에 보존합니다.
Architecture review와 runtime comparison HTML은 reference/architecture-review/ 아래에 보조 참고자료로 보존합니다.