init: readme 작성 하네스 설계
This commit is contained in:
@@ -0,0 +1,78 @@
|
||||
schema-version: 1
|
||||
sections:
|
||||
- id: overview
|
||||
title-guidance: 무엇을 만드는가
|
||||
level: 2
|
||||
purpose: 프로젝트 결과와 현재 지원 범위를 첫 화면에서 설명합니다.
|
||||
required: true
|
||||
content-strategy: inline
|
||||
content-requirements:
|
||||
- README 초안과 패치
|
||||
- Codex 지원과 다른 도구의 미검증 범위
|
||||
- id: proof
|
||||
title-guidance: 실제 결과
|
||||
level: 2
|
||||
purpose: 검토를 통과한 실제 패치 일부를 먼저 보여 줍니다.
|
||||
required: true
|
||||
content-strategy: inline
|
||||
content-requirements:
|
||||
- 실제 이전 실행의 패치 미리보기
|
||||
- 전체 패치와 출처 링크
|
||||
visual-slot:
|
||||
decision: include
|
||||
reader-question: 이 도구가 만든 실제 README 변경은 어떤 모습입니까?
|
||||
rationale: 결과가 문서인 도구는 내부 구조도보다 실제 변경 내용을 먼저 보여 줘야 합니다.
|
||||
purpose: 이전 실행에서 검토와 적용을 마친 README 패치 일부를 보여 줍니다.
|
||||
- id: quick-start
|
||||
title-guidance: 빠른 시작
|
||||
level: 2
|
||||
purpose: Codex 요청부터 결과 확인과 명시적 적용까지의 기본 경로를 제공합니다.
|
||||
required: true
|
||||
content-strategy: inline
|
||||
content-requirements:
|
||||
- 사용자 요청
|
||||
- 생성 파일
|
||||
- 성공 확인
|
||||
- 명시적 적용
|
||||
- id: usage
|
||||
title-guidance: 어떤 작업을 지원하는가
|
||||
level: 2
|
||||
purpose: 기본 모드와 세 보조 모드를 독자 작업 기준으로 구분합니다.
|
||||
required: true
|
||||
content-strategy: inline
|
||||
- id: safeguards
|
||||
title-guidance: 안전하게 다루는 방법
|
||||
level: 2
|
||||
purpose: 근거 확인과 사람 작성 내용 보존, 자동 적용 금지를 설명합니다.
|
||||
required: true
|
||||
content-strategy: inline
|
||||
- id: workflow
|
||||
title-guidance: 동작 방식
|
||||
level: 2
|
||||
purpose: 사용자 관점의 처리 순서만 짧게 보여 줍니다.
|
||||
required: true
|
||||
content-strategy: inline
|
||||
- id: inputs
|
||||
title-guidance: 입력과 생성 파일
|
||||
level: 2
|
||||
purpose: 사용자가 준비하고 확인할 파일만 설명합니다.
|
||||
required: true
|
||||
content-strategy: inline
|
||||
- id: development
|
||||
title-guidance: 개발
|
||||
level: 2
|
||||
purpose: 기여자용 설치와 테스트 경로를 사용자 경로 뒤에 둡니다.
|
||||
required: true
|
||||
content-strategy: inline
|
||||
- id: documentation
|
||||
title-guidance: 상세 문서
|
||||
level: 2
|
||||
purpose: 내부 구조와 정책을 정본 문서로 연결합니다.
|
||||
required: true
|
||||
content-strategy: inline
|
||||
- id: limitations
|
||||
title-guidance: 현재 한계
|
||||
level: 2
|
||||
purpose: 모델 작성과 검증 수준, 도구 지원 범위를 한곳에 정리합니다.
|
||||
required: true
|
||||
content-strategy: inline
|
||||
Reference in New Issue
Block a user