67 lines
2.5 KiB
JSON
67 lines
2.5 KiB
JSON
{
|
|
"title": "ClariDoc Harness 0.2.0",
|
|
"document_type": "readme",
|
|
"language": "ko-KR",
|
|
"audience": {
|
|
"roles": [
|
|
"기술 문서를 작성하거나 검토하는 소프트웨어 개발자",
|
|
"근거와 품질 게이트가 남는 문서 파이프라인을 운영하는 팀"
|
|
],
|
|
"prior_knowledge": [
|
|
"Markdown과 JSON을 읽을 수 있음",
|
|
"Python 명령줄 도구를 실행할 수 있음"
|
|
],
|
|
"needs": [
|
|
"ClariDoc이 해결하는 문제와 보장 범위",
|
|
"설치부터 최소 실행, 검증까지 이어지는 경로",
|
|
"provider, 근거, 문체 계약의 선택 기준"
|
|
]
|
|
},
|
|
"reader_goal": "ClariDoc의 근거 중심 작성 흐름을 이해하고 설치, 최소 실행, 검증을 직접 수행한다",
|
|
"core_message": "ClariDoc은 Brief와 SourcePack, 문서 유형별 구조, 결정적 lint, 독립 리뷰, 품질 게이트를 연결해 독자용 문서와 내부 provenance를 분리합니다.",
|
|
"scope": [
|
|
"ClariDoc 0.2.0의 목적과 전체 파이프라인",
|
|
"지원 문서 유형과 provider 역할",
|
|
"설치, 로컬 근거 수집, mock 실행, 검증",
|
|
"한국어 기술 블로그와 README의 경험형 문체 계약"
|
|
],
|
|
"non_scope": [
|
|
"외부 provider의 설치와 인증을 자동으로 완료하는 기능",
|
|
"모델 리뷰 결과가 사실의 진실성을 보장한다는 주장",
|
|
"대상 시스템에서 실행하지 않은 코드와 운영 동작의 보장"
|
|
],
|
|
"prerequisites": [
|
|
"Python 3.10 이상",
|
|
"프로젝트 저장소의 Markdown과 JSON 파일을 읽을 권한"
|
|
],
|
|
"required_topics": [
|
|
"Brief와 SourcePack",
|
|
"STRUCTURE_SPECS와 reader-facing document",
|
|
"provenance와 evidence map",
|
|
"provider 역할과 mock 한계",
|
|
"STYLE002와 STYLE003",
|
|
"quality gate와 검증 산출물"
|
|
],
|
|
"constraints": {
|
|
"target_words": 1800,
|
|
"tone": "작성자의 문제와 선택을 직접 설명하는 전문적인 한국어 README 문체",
|
|
"version_context": "ClariDoc 0.2.0",
|
|
"max_heading_depth": 3,
|
|
"require_citations": true,
|
|
"allow_external_knowledge": false,
|
|
"citation_style": "hidden",
|
|
"date_policy": "only_when_material",
|
|
"style_profile": "auto"
|
|
},
|
|
"forbidden_claims": [
|
|
"Mock 실행이 문서 품질을 증명한다",
|
|
"모델 리뷰의 합의가 사실의 진실성을 증명한다",
|
|
"모든 외부 provider가 기본 설치되어 있다"
|
|
],
|
|
"metadata": {
|
|
"owner": "documentation-team",
|
|
"risk": "medium",
|
|
"example_kind": "repository-readme"
|
|
}
|
|
}
|