init: readme 작성 하네스 설계
This commit is contained in:
@@ -0,0 +1,56 @@
|
||||
schema-version: 1
|
||||
target:
|
||||
repository: /home/donghyeon/workspace/ai-tool/image-haness
|
||||
readme-path: README.md
|
||||
mode: bootstrap
|
||||
profile-override: generic
|
||||
project-intent:
|
||||
purpose: 저장소가 만드는 문서·기술 그림·이미지를 먼저 보여 주고, 각 기능의 책임과 실행 방법을 실제 구현과 검증 결과에 근거해 설명한다.
|
||||
positioning: 콘텐츠 하네스를 처음 살펴보는 개발자와 기능을 수정하려는 기여자가 필요한 정보를 빠르게 찾는 저장소 안내서다.
|
||||
maturity: 검토를 통과한 대표 산출물, 현재 구현, 실행한 테스트, 아직 끝나지 않은 검증을 서로 구분해 적는다.
|
||||
audience:
|
||||
primary:
|
||||
- 콘텐츠 하네스가 무엇을 만들고 어떻게 확인하는지 알고 싶은 개발자
|
||||
- 문서 작성, 기술 시각화, 이미지 생성 흐름을 수정하려는 개발자
|
||||
secondary:
|
||||
- 생성 문서와 시각 산출물의 계약·검증 방식을 검토하는 기술 리더
|
||||
reader-actions:
|
||||
- 검토를 통과한 문서, 이미지, 기술 시각화 결과를 바로 확인한다.
|
||||
- 가장 짧은 예제 명령과 전체 테스트 명령을 실행한다.
|
||||
- 각 기능이 맡는 일과 수정할 디렉터리를 찾는다.
|
||||
- 실행 기록과 버전 관리되는 예시를 구분한다.
|
||||
- 필요한 도구와 아직 끝나지 않은 검증을 확인한다.
|
||||
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: 4
|
||||
preferred-formats:
|
||||
- repository-owned raster or SVG artifact
|
||||
- mermaid
|
||||
placeholder-format: HTML 주석 기반 제작 사양; 검증된 기존 산출물은 저장소 상대 경로로 직접 표시
|
||||
must-include:
|
||||
- 프로젝트 개요와 대상 독자
|
||||
- 검토 완료된 이미지 생성, 기술 시각화, 통합 문서 산출물 3종과 출처 기록
|
||||
- document-writing, technical-visualization, image-generation, workflow-runtime의 책임과 연결 관계
|
||||
- 대표 검증 또는 실행 흐름과 명령별 검증 수준
|
||||
- 테스트로 생성된 이미지, 문서, 기술 시각화 산출물의 실제 경로와 성격
|
||||
- 저장소 구조와 기여 위치
|
||||
- 필수 및 선택 도구
|
||||
- runs 디렉터리의 실행 기록 성격과 정본으로 사용하지 않는다는 경계
|
||||
- 현재 구현 상태와 확인된 한계
|
||||
- ARCHITECTURE.md와 docs 색인 링크
|
||||
must-exclude:
|
||||
- 저장소 근거가 없는 기능·버전·성능·품질 우위 주장
|
||||
- 실패·중간 후보 산출물을 성공 예시로 오인시키는 표현
|
||||
- 비밀 값 또는 개인 환경의 절대 경로
|
||||
- 상세 설계 이력과 모든 run 파일의 장문 나열
|
||||
- 일반 개념을 불필요하게 영어로 나열하는 제목과 설명
|
||||
- 작성 과정이나 문서 자체를 설명하는 메타 문장
|
||||
- 독자의 행동과 관계없는 수식어, 반복 요약, 장식용 문구
|
||||
- runs 경로의 파일을 README에 직접 삽입하는 링크
|
||||
protected-sections: []
|
||||
Reference in New Issue
Block a user