문제: 설계서·계획서·납품 패키지·증거·학습 문서와 ADR이 기록이라는 표시 없이 지금 문서처럼 읽힌다. 상태 칸이 설계서 72개 중 40개, 계획서는 거의 없고, 있어도 Approved·확정·Accepted.처럼 값이 제각각이며 영어다. 고른 방법: docs/design, docs/history, docs/adr, docs/notification/adr의 .md 246개 맨 위에 같은 모양의 머리 블록을 단다. 칸은 상태·작성일· 요약(한국어 한 문장)·현재 정본, 대체됐으면 대체됨이다. 블록은 표시 줄 두 개로 감싸서 빼면 원문 바이트가 그대로 돌아온다(246개 모두 대조함). - 종류는 폴더가 정하고 둘째 줄에 적는다(plans/evidence는 증거). - 상태는 원래 상태 줄을 고정 어휘로 바꾼 값이다. 상태 줄이 없는 설계서와 체크 상자가 다 표시되지 않은 계획서는 「확인 안 함」. capability-status.md 제거 표로 지운 것이 확인된 설계서 다섯은 「폐기」, 2026-07-20 하네스 설계·계획과 production capability platform 설계는 「대체됨」이다. - 현재 정본은 구조 정리로 옮겨질 수 있는 src/messaging·src/grpc 대신 docs/ 쪽 문서나 옮기지 않는 leaf README를 가리킨다. docs/README.md에 「문서 수명과 언어」「기록 문서의 머리 블록」「문서와 코드를 같은 변경에서 고친다」를 더하고, 파생 서비스 안내에 머리 블록 충돌 가능성을 적었다. 버린 대안: H1 제목 아래에 블록을 두는 안은 보기에는 낫지만 빼는 규칙이 파일마다 달라져 원문 복원이 기계적이지 않다. 「종류」 칸을 따로 두는 안은 폴더와 같은 정보를 두 번 쓰게 한다. 위험·한계: 「확인 안 함」 설계서 38개, 계획서 51개는 지금 유효한지 아무도 판정하지 않았다. 요약은 제목·목표 줄을 보고 쓴 것이라 본문을 끝까지 읽지 않았다. 납품 패키지 셋의 MANIFEST.sha256는 이제 맞지 않는다 (납품 당시 바이트의 해시이고, 블록을 빼면 다시 맞는다). 리뷰 폴더에는 아직 머리 블록을 달지 않았다. 검증: 머리 블록을 뺀 내용과 HEAD 원본 246개 일치, check-work-docs.py rc=0, --links docs·README.md·CLAUDE.md·AGENTS.md 깨진 링크 0.
4.1 KiB
기록 · 설계서 본문은 쓴 때의 원문이다. 지금 동작은 「현재 정본」을 읽는다.
- 상태: 확인 안 함
- 작성일: 2026-09-19
- 요약: env 키 검사가 선언과 실제 사용을 구분하게 하는 설계다.
- 현재 정본:
docs/registries/env-keys.yaml
Env Contract Verifier Truth Surface
Goal
Close tech-lead H1 and H2 by making verifyEnvKeys distinguish declaration from consumption and by covering the configuration files Spring actually ships.
H1: declaration is not consumption
.env.example is the operator-facing declaration surface. A key being listed there proves that an adopter can discover the key; it does not prove that runtime code reads it.
Consumer evidence is therefore limited to:
- APP references in the configuration resources being verified;
- APP references in production main sources/configuration resources elsewhere in the repository;
- typed configuration properties, which are already handled separately through metadata and do not enter the untyped orphan set.
The envAppKeys set must not be merged into consumed.
The existing ownership policy remains:
- orphaned rows under enforced Redis prefixes fail the task;
- orphaned rows outside that owned surface are emitted as warnings until their owning concern removes, wires, or explicitly deprecates them;
- deprecated_orphaned remains an explicit transition state, never an automatic escape hatch.
Sample-portfolio main configuration is valid consumer evidence for repository-level env rows. It is not part of the app-bootstrap shipped-configuration validation surface.
H2: all shipped app-bootstrap configuration is verified
verifyEnvKeys must scan a ConfigurableFileCollection instead of one application.yml file.
The collection contains:
- application.yml;
- application-local.yml / application-dev.yml / application-prod.yml when present;
- every config/*.yml resource shipped by app-bootstrap.
Required-placeholder and APP-key registry checks operate over the union of these files.
The current application.yml import list and config directory are one-to-one (15 imported files, 15 files). Existing contract tests continue to guard the import topology; verifyEnvKeys owns the environment-key contract across those resources.
Consumer-source scan
The repository consumer scan includes main Java and main YAML resources and excludes generated build output. This lets a registered key used only by the reference sample count as genuinely used without pretending that sample configuration is part of app-bootstrap.
Verification
Unit tests must prove:
- an env + registry row with no runtime/config consumer is no longer hidden by .env.example;
- an enforced Redis orphan hard-fails;
- a reference that appears only in a secondary configuration file participates in registry and required-placeholder checks;
- the task exposes configurationFiles as ConfigurableFileCollection.
Repository verification must then run verifyEnvKeys against the real tree and report any newly visible orphan rows instead of silently treating .env.example as a consumer.
Verified result
- build-tools full test: PASS (63 tests);
- .env.example no longer contributes to consumer evidence;
- verifyEnvKeys scans application*.yml plus all config/*.yml and repository main Java/YAML consumer sources;
- the repaired verifier immediately exposed two real profile-config drift keys, APP_FLYWAY_ENABLED and APP_PERSISTENCE_VENDOR; both are real runtime/developer knobs and are now registered in .env.example and env-keys.yaml;
- H1 then exposed seven unconsumed rows. APP_MESSAGING_PRODUCER_ID was a real missing wiring and is now bound in config/messaging.yml; six rows with no production/sample/config/test consumer were removed from .env.example and the registry instead of being falsely deprecated;
- final verifyEnvKeys: PASS with 339 env keys, 6 required placeholders, 229 application APP references, 61 typed properties and no orphan warning;
- focused messaging/JPA/profile configuration regressions: PASS;
- git diff --check: PASS.