docs: apply Korean prose contract to README

This commit is contained in:
DongHyeonka
2026-07-29 18:44:50 +09:00
parent a066b89a7a
commit 89e09cbc20
6 changed files with 250 additions and 43 deletions
+36
View File
@@ -144,6 +144,42 @@ def _korean_body(brief: Brief, intent: str) -> list[str]:
if intent in technical_blog:
return technical_blog[intent]
readme: dict[str, list[str]] = {
"problem_value": [
f"처음에는 필요한 정보를 한 문서에 모으면 독자가 바로 시작할 수 있다고 생각했습니다. 그런데 저는 설치 방법만으로는 {topics}의 목적과 경계, 성공 기준을 판단하기 어렵다는 점을 확인했습니다. 이 README는 다음 목표를 가장 짧은 실행 경로와 연결합니다. **{brief.reader_goal}**",
f"제가 전달하려는 핵심은 “**{brief.core_message}**”입니다. 설명 범위는 {scope}이며, {non_scope}까지 검증했다고 주장하지 않습니다.",
],
"principles": [
f"저는 사용자가 실행 전에 보장 범위부터 확인할 수 있도록 {topics}의 원칙과 경계를 분리했습니다. 현재 구현이 보장하는 동작은 명시하고, 검증하지 않은 동작은 비보장 범위로 남깁니다.",
"내부 추적 정보와 독자용 결과도 분리합니다. 근거 식별자와 로컬 경로는 provenance에 남기고, README 본문에는 사용자가 설치하고 실행하고 확인하는 데 필요한 내용만 둡니다.",
],
"workflow": [
"제가 연결한 전체 흐름은 입력 확인, 구조 결정, 실행, 검증, 결과 분리 순서입니다. 각 단계는 앞 단계의 산출물을 입력으로 사용하며, 실패하면 다음 단계로 넘어가지 않습니다.",
"```text\n입력 계약 → 구조 결정 → 실행 → 검증 → 독자용 결과 + 내부 기록\n```",
],
"installation": [
f"실행 전에 {prereq}를 준비합니다. 저는 지원 버전과 필수 도구를 먼저 확인하고, 격리된 환경에 필요한 의존성만 설치하는 경로를 기준으로 삼았습니다.",
"```bash\npython3 -m venv .venv\n. .venv/bin/activate\npython -m pip install -e .\n```",
],
"quickstart": [
"제가 가장 먼저 확인하는 경로는 입력 계약 검증과 결정적 목차 생성입니다. 이 두 단계가 성공하면 문서 유형과 필수 절의 순서를 실행 전에 확인할 수 있습니다.",
"```bash\nclaridoc validate --brief brief.json --sources sources.json\nclaridoc outline --brief brief.json --sources sources.json --output outline.json\n```",
],
"configuration": [
f"주요 설정은 {topics}의 동작 범위와 검증 수준을 바꿉니다. 기본값을 그대로 사용할 때와 별도 provider나 인용 정책을 선택할 때의 비용을 구분합니다.",
"설정을 바꿀 때는 독자용 결과, 내부 provenance, 품질 게이트 가운데 어느 경계에 영향을 주는지 확인합니다. 검증하지 않은 설정 조합은 지원한다고 확대해 쓰지 않습니다.",
],
"verification": [
f"저는 같은 입력으로 검증을 반복하고 다음 목표가 관측되는지 확인합니다. **{brief.reader_goal}** 성공 여부는 종료 코드와 생성된 구조·lint·품질 게이트 산출물로 판단합니다.",
"예상 파일이 없거나 blocker가 남아 있으면 중단합니다. Mock 결과는 파이프라인 연결만 증명하며, 문장이나 사실의 품질을 증명하지 않습니다.",
],
"limits_next": [
f"제가 확인한 범위는 {scope}입니다. {non_scope}는 현재 결과로 보장하지 않습니다. 다음 단계에서는 실제 프로젝트 근거와 provider를 연결하고 같은 검증 절차를 다시 실행합니다.",
],
}
if intent in readme:
return readme[intent]
procedural: dict[str, list[str]] = {
"outcome": [f"완성 결과는 **{brief.reader_goal}**이다. {brief.core_message}", f"대상 범위는 {scope}이며 {non_scope}는 다루지 않는다."],
"goal": [f"목표는 **{brief.reader_goal}**이다. {brief.core_message}", f"이 절차는 {scope}에 적용하고 {non_scope}에는 적용하지 않는다."],