Skip to content

Latest commit

 

History

History
61 lines (49 loc) · 3.88 KB

File metadata and controls

61 lines (49 loc) · 3.88 KB

Noema Documentation Map

이 디렉터리는 Noema의 canonical documentation graph를 제공합니다. PR body, issue comment, automation summary는 실행 시점 evidence일 수 있지만 architecture source of truth를 대체하지 않습니다.

Start here

Need Document
제품이 누구를 위해 무엇을 해야 하는가 PRD
기술적으로 어떤 invariant를 지켜야 하는가 TRD
bounded context와 외부 authority 관계 Context Map
runtime/MSA/trust boundary Architecture
왜 이 결정을 했는가 ADR index
component/sequence/state/topology 그림 UML
persisted state와 conceptual evidence entities ERD
requirement → source/test/evidence 연결 Traceability
현재 제품·기술 Gap, owner와 완료 증거 Product and technical gap baseline
무엇을 어떻게 테스트하는가 Test Strategy
activation/incident/rollback/production acceptance Operability
licensing, third-party obligations, IP transfer Licensing and IP transfer
HTTP API prose contract API spec
protected HTTP API machine contract OpenAPI 3.1
credential-exchange runtime 위협 Runtime threat model
autonomous review/maintenance/publisher 위협 Automation threat model
문서군의 충분성·잔여 gap·acceptance 상태 Documentation gap audit
표준·primary-source 근거 Architecture doctoring

Operations and release

Commercial and acquisition evidence

These documents describe requirements and evidence locations. Missing real production/customer/revenue/transfer evidence must remain missing rather than being replaced by documentation.

Status vocabulary

  • Implemented on protected main — source/control family is protected truth; deployment/operational proof remains separate where applicable.
  • Implemented on active PR / In review — behavior exists only on a current open head.
  • Accepted architecture — a durable decision is accepted but may not yet be implemented.
  • Planned — no implementation claim.
  • Research only — evidence informs design but is not product behavior.
  • External evidence — repository source alone cannot establish it.
  • Superseded — retained historical decision replaced by a newer authority.
  • Out of scope — explicitly not owned.

Update rule

A material product/security/authority change should update the smallest complete set among PRD, TRD, Context Map, Architecture, ADR, UML/ERD, threat models, API, Operability, Test Strategy, Traceability, documentation-gap audit and CHANGELOG. Do not duplicate the same mutable status in many documents when a canonical owner already exists. Remove obsolete PR numbers and transient check conclusions rather than preserving them as timeless architecture facts.