147 lines
6.9 KiB
YAML
147 lines
6.9 KiB
YAML
schema-version: 1
|
|
sections:
|
|
- id: overview
|
|
title-guidance: Content Harness
|
|
level: 1
|
|
purpose: 프로젝트의 구체적 결과, provider-neutral 경계, 대상 독자를 첫 화면에서 설명한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 한 문단 정체성과 가치
|
|
- 네 capability와 publication 결과를 한 줄로 요약
|
|
- 대상 독자와 README가 제공하는 최소 경로
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 첫 화면에 별도 hero 이미지가 이해를 실질적으로 높이는가?
|
|
rationale: 저장소 소유의 영구 hero asset이 없고 로컬 runs 이미지는 ignored이므로 구체적 설명이 더 정확하다.
|
|
|
|
- id: capabilities
|
|
title-guidance: 책임이 섞이지 않는 네 capability
|
|
level: 2
|
|
purpose: document writing, technical visualization, image generation, workflow runtime의 책임·출력·금지 경계를 비교한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 네 capability 비교표
|
|
- 기술 도형과 유기적 이미지의 선택 기준
|
|
- integrations가 publication projection만 소비한다는 경계
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: capability별 책임을 비교할 때 별도 그림이 표보다 나은가?
|
|
rationale: 책임·입력·출력·금지를 정확히 짝짓는 표가 탐색과 유지보수에 더 적합하다.
|
|
|
|
- id: quick-start
|
|
title-guidance: 2분 검증
|
|
level: 2
|
|
purpose: 의존성 전제와 체크인된 예제의 contract validation 및 front-door 계획을 재현한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- Python과 feature-specific 도구 전제
|
|
- canonical install manifest 부재 고지
|
|
- 실행 확인된 content-job validation
|
|
- 실행 확인된 front-door plan
|
|
- 기대 결과와 production execution이 아님을 명시
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 짧은 복사 실행 경로에 그림이 필요한가?
|
|
rationale: 두 command와 기대 결과를 순서대로 제시하는 편이 더 직접적이다.
|
|
|
|
- id: execution-model
|
|
title-guidance: 요청에서 publication까지
|
|
level: 2
|
|
purpose: contract chain, routing, sibling harness, ArtifactSet, integration의 데이터 흐름과 경계를 설명한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- ContentJobRequest에서 publication projection까지의 단계
|
|
- technical-only, image-only, hybrid routing
|
|
- runtime만 sibling 결과를 조립한다는 관계
|
|
- 검토되지 않은 결과가 publication으로 넘어가지 않는 경계
|
|
visual-slot:
|
|
decision: include
|
|
reader-question: 세 sibling branch와 contract chain이 어디서 합류하는가?
|
|
rationale: 선형 설명만으로는 document, technical, image branch와 runtime 소유 합류점을 동시에 파악하기 어렵다.
|
|
purpose: 요청과 contract가 workflow-runtime을 통해 sibling capability로 분기하고 검토된 publication으로 합류하는 흐름을 보여준다.
|
|
|
|
- id: artifacts
|
|
title-guidance: 생성 산출물 둘러보기
|
|
level: 2
|
|
purpose: versioned fixture, 로컬 테스트 생성 문서·이미지·기술 시각화, portable output의 차이를 명시한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 체크인된 Clean Architecture contract fixture 링크
|
|
- 현재 작업 사본에서 확인된 cross-harness output 유형과 경로
|
|
- document visualization 및 best-of-three image 예시
|
|
- runs가 ignored이고 정본이 아니라는 경고
|
|
- GitHub에 보일 gallery로 쓰려면 examples 또는 docs로 승격해야 한다는 안내
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 로컬 test output을 README에 직접 임베드해도 지속 가능한가?
|
|
rationale: runs 전체가 ignored라 링크가 clean checkout과 GitHub에서 깨지므로 경로·유형·승격 정책을 표로 설명한다.
|
|
|
|
- id: architecture
|
|
title-guidance: 저장소 구조와 변경 위치
|
|
level: 2
|
|
purpose: adapters, harnesses, packages, integrations, tests, examples, benchmarks, runs의 소유권과 의존 방향을 연결한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 주요 디렉터리 책임 표
|
|
- canonical dependency direction
|
|
- 계약·capability·runtime·publication 변경 시 시작 위치
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 기여 위치를 찾는 데 두 번째 구조 그림이 필요한가?
|
|
rationale: 이미 execution flow visual이 있고 경로·책임 표가 파일 탐색에는 더 정확하다.
|
|
|
|
- id: verification
|
|
title-guidance: 검증 명령과 증거 수준
|
|
level: 2
|
|
purpose: 이번 README 작업에서 실행한 명령과 발견만 한 전체 suite를 분리해 제시한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 실행 확인한 contract, ArtifactSet, layout test 명령
|
|
- full unittest discovery command는 미실행임을 명시
|
|
- end-to-end는 외부 evidence와 review 파일이 필요하다는 링크
|
|
- 명령별 성공 신호
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 검증 수준 선택에 그림이 필요한가?
|
|
rationale: 목적·명령·성공 신호·실행 수준을 짝지은 표가 더 명료하다.
|
|
|
|
- id: limitations
|
|
title-guidance: 현재 상태와 한계
|
|
level: 2
|
|
purpose: dependency metadata, ignored outputs, benchmark maturity, external inputs, qualification 상태를 과장 없이 밝힌다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- canonical dependency installer와 version pin 부재
|
|
- runs 출력의 비영속성
|
|
- document/image benchmark 결과 pending
|
|
- d2-svg-layer-compositor 사람 Gate 3 pending
|
|
- 전체 unittest suite는 이번 README 작업에서 재실행하지 않았다는 검증 범위
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 현재 제약을 이해하는 데 그림이 필요한가?
|
|
rationale: 상태·영향·후속 행동을 한 줄씩 연결한 목록이 더 정확하다.
|
|
|
|
- id: documentation
|
|
title-guidance: 문서와 정본 지도
|
|
level: 2
|
|
purpose: architecture, runtime workspace, capability guide, examples, benchmark로 목적별 이동 경로를 제공한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- ARCHITECTURE.md와 docs/README.md
|
|
- runs/README.md
|
|
- 세 harness README와 workflow runtime README
|
|
- examples, end-to-end, benchmark index
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 세부 정본을 찾는 데 시각화가 필요한가?
|
|
rationale: 목적별 상대 링크 목록이 GitHub 탐색과 유지보수에 가장 적합하다.
|