142 lines
5.5 KiB
YAML
142 lines
5.5 KiB
YAML
schema-version: 1
|
|
sections:
|
|
- id: overview
|
|
title-guidance: Content Harness
|
|
level: 1
|
|
purpose: 무엇을 만드는 저장소인지 두 문장 안에 밝힌다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 만드는 결과와 작업 실행기의 역할
|
|
- 이 문서가 도움 되는 독자
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 별도 표지 그림이 첫 설명보다 필요한가?
|
|
rationale: 바로 아래 대표 산출물이 실제 결과를 보여 주므로 장식 그림은 넣지 않는다.
|
|
|
|
- id: showcase
|
|
title-guidance: 검토를 마친 결과 예시
|
|
level: 2
|
|
purpose: 검토 완료된 이미지, 기술 그림, 통합 문서를 README 안에서 보여 준다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 이미지 생성 결과와 무엇을 판단할 수 있는지 설명
|
|
- 기술 시각화 결과와 무엇을 판단할 수 있는지 설명
|
|
- 세 기능을 합친 문서 미리보기
|
|
- 출처 실행, 검토 상태, 해시를 기록한 provenance 링크
|
|
visual-slot:
|
|
decision: include
|
|
reader-question: 실제로 어떤 결과를 만드는지 바로 확인할 수 있는가?
|
|
rationale: 결과물 자체를 보는 것이 기능 이름을 나열하는 것보다 빠르고 정확하다.
|
|
purpose: 검토 완료 산출물 세 개를 역할과 함께 보여 준다.
|
|
|
|
- id: quick-start
|
|
title-guidance: 먼저 실행해 보기
|
|
level: 2
|
|
purpose: 준비 사항과 가장 짧은 예제 검증 경로를 제공한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- Python과 선택 도구
|
|
- 정본 설치 명령이 없는 이유
|
|
- 요청 검사와 작업 계획 명령
|
|
- 실제 확인한 성공 결과와 범위
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 두 명령을 실행하는 데 그림이 필요한가?
|
|
rationale: 복사할 수 있는 명령과 성공 신호만 두는 편이 빠르다.
|
|
|
|
- id: capabilities
|
|
title-guidance: 기능별 책임
|
|
level: 2
|
|
purpose: 네 기능이 맡는 일과 하지 않는 일을 구분한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 문서 작성
|
|
- 기술 시각화
|
|
- 이미지 생성
|
|
- 작업 실행기와 통합 어댑터
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 책임을 비교할 때 별도 그림이 필요한가?
|
|
rationale: 짧은 소제목과 경계 설명이 경로를 찾는 데 더 정확하다.
|
|
|
|
- id: execution-model
|
|
title-guidance: 요청이 결과가 되는 과정
|
|
level: 2
|
|
purpose: 계약 순서, 분기, 검토, 게시 파일 생성을 한 흐름으로 설명한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 계약 사슬
|
|
- 기술 그림과 이미지 분기 규칙
|
|
- 검토를 통과한 결과만 합치는 경계
|
|
visual-slot:
|
|
decision: include
|
|
reader-question: 세 기능이 어디서 갈라지고 합쳐지는가?
|
|
rationale: 분기와 합류가 함께 있어 작은 흐름도가 문장보다 빠르다.
|
|
purpose: 작업 실행기가 세 기능을 나누고 결과를 합치는 과정을 보여 준다.
|
|
|
|
- id: architecture
|
|
title-guidance: 저장소 구성과 변경 위치
|
|
level: 2
|
|
purpose: 수정 목적에 따라 시작할 디렉터리를 안내한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 주요 디렉터리의 정본 책임
|
|
- 어댑터, 하네스, 계약의 의존 방향
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 파일 경로를 찾는 데 그림이 표보다 나은가?
|
|
rationale: 경로와 책임을 짝지은 표가 바로 이동하기 쉽다.
|
|
|
|
- id: verification
|
|
title-guidance: 검증
|
|
level: 2
|
|
purpose: 이번 작업에서 실행한 검사와 성공 신호를 적는다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 콘텐츠 명세 검사
|
|
- 산출물 묶음 검사
|
|
- 저장소 구성 검사
|
|
- 전체 300개 테스트 결과
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 검사 결과를 이해하는 데 그림이 필요한가?
|
|
rationale: 명령과 성공 결과를 바로 붙이는 편이 재현하기 쉽다.
|
|
|
|
- id: limitations
|
|
title-guidance: 현재 한계
|
|
level: 2
|
|
purpose: 설치, 실행 기록, 외부 입력, 아직 끝나지 않은 평가를 밝힌다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 패키지 설정 파일 부재
|
|
- runs의 비영속성
|
|
- 외부 입력이 필요한 종단 간 실행
|
|
- 평가 자료와 사람 검토 상태
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 남은 제약을 이해하는 데 그림이 필요한가?
|
|
rationale: 영향과 후속 행동을 붙인 짧은 목록이면 충분하다.
|
|
|
|
- id: documentation
|
|
title-guidance: 더 읽을 문서
|
|
level: 2
|
|
purpose: 설계와 기능별 상세 문서로 이동하는 링크를 제공한다.
|
|
required: true
|
|
content-strategy: inline
|
|
content-requirements:
|
|
- 전체 설계
|
|
- 문서 색인과 실행 작업공간 정책
|
|
- 기능별 안내서와 종단 간 예제
|
|
visual-slot:
|
|
decision: exclude
|
|
reader-question: 세부 문서를 찾는 데 그림이 필요한가?
|
|
rationale: 목적을 붙인 상대 링크 목록이 가장 빠르다.
|