58 lines
2.8 KiB
YAML
58 lines
2.8 KiB
YAML
schema-version: 1
|
|
target:
|
|
repository: /home/donghyeon/workspace/ai-tool/readme-harness
|
|
readme-path: README.md
|
|
mode: bootstrap
|
|
profile-override: library
|
|
project-intent:
|
|
purpose: 저장소의 실제 코드와 사용자 요구를 바탕으로 검증 가능한 README 후보와 명시적으로 적용할 패치를 만드는 하네스를 설명한다.
|
|
positioning: 사실 추적과 적용 안전성뿐 아니라 독자 과업, 공개 용어, 실제 시각 자료, 근거가 고정된 품질 심사를 함께 다루는 README 제작 도구다.
|
|
maturity: Codex 경로의 bootstrap, audit, refresh, section-update는 구현됐고 도구 간 런타임 동등성은 아직 주장하지 않는다.
|
|
audience:
|
|
primary:
|
|
- 저장소 README를 새로 만들거나 안전하게 갱신하려는 개발자
|
|
secondary:
|
|
- 하네스의 게이트와 워크플로를 확장하는 기여자
|
|
reader-actions:
|
|
- 이 프로젝트가 어떤 결과를 만들고 무엇을 보장하는지 30초 안에 판단한다.
|
|
- 개발 환경을 준비하고 전체 테스트를 실행해 설치 상태를 확인한다.
|
|
- 작업에 맞는 bootstrap, audit, refresh, section-update 모드를 고른다.
|
|
- 생성된 패치를 검토한 뒤 별도의 명시적 적용 단계를 실행한다.
|
|
content-policy:
|
|
language: ko-KR
|
|
tone: 직접적이고 검증 수준을 분명히 밝히는 기술 설명체
|
|
target-length: medium
|
|
preserve-existing-copy: false
|
|
detail-docs-policy: summary-and-link
|
|
visual-policy:
|
|
mode: when-useful
|
|
max-visuals: 1
|
|
preferred-formats:
|
|
- mermaid
|
|
placeholder-format: HTML 주석 기반 제작 사양
|
|
terminology-policy:
|
|
exact-identifiers: []
|
|
explain-on-first-use: {}
|
|
internal-only:
|
|
family: 작업 담당 방식
|
|
fan-out: 여러 담당자가 나눠 검토
|
|
collapse: 한 담당자가 맡아 처리
|
|
concrete worker: 실제 변경 담당자
|
|
verification family: 검증 담당 역할
|
|
route-to: 재작업 시작 상태
|
|
must-include:
|
|
- 한 문장 가치 제안과 대상 독자
|
|
- 설치 전제조건과 복사 가능한 첫 테스트 경로
|
|
- 네 가지 모드의 독자 작업 기준 선택법
|
|
- 저장소 분석부터 패치 적용까지의 한 화면 처리 흐름
|
|
- 사실, 명령, 경로, 비밀 값, 보호 영역, 품질 근거에 대한 안전장치
|
|
- 생성되는 주요 산출물과 명시적 적용 경계
|
|
- Codex 경로 구현 범위와 도구 간 동등성 한계
|
|
- 아키텍처, 시각화, 상태기계 상세 문서 링크
|
|
must-exclude:
|
|
- 저장소 근거 없는 최상 품질, 성능, 생산 준비 완료 주장
|
|
- 전체 상태 이름과 내부 역할 배치를 첫 화면에서 장황하게 나열하는 설명
|
|
- 내부 오케스트레이션 영문 용어를 독자용 개념처럼 노출하는 문장
|
|
- 검증되지 않은 설치·실행 명령
|
|
protected-sections: []
|