chore: 문서 수정

This commit is contained in:
DongHyeonka
2026-07-29 18:29:25 +09:00
parent 3ac0a367dc
commit 4b7f1a90d2
29 changed files with 1594 additions and 747 deletions
@@ -7,24 +7,49 @@ description: Use when a Korean technical blog or reader-facing document should r
## 핵심 원칙
기술 사실을 설명문으로 나열하지 말고, 작성자가 직접 코드를 보고 실행하면서 예상하고, 발견하고, 판단하고, 바꾼 과정으로 쓴다. 논리와 근거는 그대로 두고 서술 관점과 문장 형식만 고친다.
기술 사실을 설명문으로 나열하지 말고, 서술자가 코드를 만들고 판단했거나 직접 확인한 과정으로 쓴다. 먼저 서술자가 코드의 작성자인지 외부 분석자인지 확정한다. 논리와 근거는 그대로 두고 서술 관점과 문장 형식만 고친다.
[문장 패턴](references/sentence-patterns.md)을 처음부터 끝까지 읽은 뒤 수정한다.
## 서술자의 위치부터 고정하기
사용자가 자신이 만든 코드라고 밝혔다면 작성자 관점으로 쓴다. `처음 저장소를 열었습니다`, `코드를 따라가 보니`, `모듈을 훑어봤습니다`, `확인해 보니 이런 구조였습니다`처럼 다른 사람의 코드를 분석하는 표현을 쓰지 않는다.
작성자 관점에서는 다음 내용을 앞에 둔다.
- 만들 때 해결하려 한 문제
- 당시 정한 기준과 선택
- 그 선택을 코드와 빌드에 옮긴 방법
- 구현을 끝낸 범위와 아직 연결하지 않은 범위
- 선택하면서 받아들인 비용
예를 들어 `처음 코드를 열었을 때 19개 모듈이 보였습니다`가 아니라 `코어의 클래스패스를 제한하고 선택형 어댑터를 분리하면서 19개 모듈로 만들었습니다`라고 쓴다. 소유 관계가 확인되지 않았다면 작성자 경험을 만들어 내지 않는다.
## 경험담 문체
문서의 시작과 주요 전환에서는 `저는`이나 `제가`를 사용한다. 모든 문장에 반복하지는 않는다. 다음 흐름으로 문단 전체를 다시 쓴다.
1. 처음 마주한 코드, 화면, 요청 또는 문제를 보여 준다.
1. 처음 마주한 코드, 화면, 요청 또는 만들 때 해결하려 한 문제를 보여 준다.
2. 당시의 예상이나 처음 보인 인상을 짧게 적는다.
3. `그런데` 뒤에 실제 실행이나 코드 추적에서 발견한 차이를 둔다.
4. 낯선 용어는 그때 이해한 내용처럼 바로 풀어 쓴다.
5. 그 차이 때문에 무엇을 확인하고 선택하거나 바꿨는지 적는다.
6. 결과와 함께 새로 생긴 비용이나 남은 문제를 적는다.
여섯 요소의 이름은 출력하지 않고 필요한 요소만 쓴다. 독자가 작성자의 확인 순서를 따라가게 하며, 기준 문단이 `~했습니다`를 사용하면 같은 높임말을 유지한다.
여섯 요소의 이름은 출력하지 않고 필요한 요소만 쓴다. 독자가 작성자의 판단과 확인 순서를 따라가게 하며, 기준 문단이 `~했습니다`를 사용하면 같은 높임말을 유지한다.
`첫 번째 제약이다`를 지우거나 `호출 주체`를 구성요소 이름으로 바꾸는 것만으로는 교정이 끝나지 않는다. `처음에는`, `그런데 확인해 보니`, `그래서`, `그 결과`로 이어지는 경험의 흐름이 보여야 한다.
`첫 번째 제약이다`를 지우거나 `호출 주체`를 구성요소 이름으로 바꾸는 것만으로는 교정이 끝나지 않는다. 경험의 흐름도 서술자의 위치에 맞춰야 한다. 외부 분석자는 `처음에는`, `그런데 확인해 보니`로 쓸 수 있지만, 작성자는 `만들 때`, `구현하면서`, `그래서 …로 나눴습니다`, `그 결과`로 자신의 판단과 작업을 설명한다.
## 문장 종결을 문서 전체에서 맞추기
사용자가 `~했습니다` 문체를 예시로 주었거나 기준 문서가 높임말이면, 제목·표의 명사구·인용문·코드 블록을 제외한 독자용 본문 전체를 다음 어투로 쓴다.
- 직접 확인하거나 수행한 일: `확인했습니다`, `따라갔습니다`, `생각했습니다`
- 현재 동작과 기술 설명: `사용합니다`, `호출합니다`, `막습니다`
- 상태와 판단: `있습니다`, `없습니다`, `입니다`, `아닙니다`
- 부정: `다루지 않습니다`, `보장하지 않습니다`
한 문단만 `저는 확인했습니다`로 열고 뒤에서 `있다`, `한다`, `아니다`, `다루지 않는다`로 돌아가면 교정이 끝난 것이 아니다. 수정이 끝나면 fenced code를 제외한 본문에서 평서형 종결이 남았는지 따로 검색한다. 원문 코드, 직접 인용, 명령 출력은 어투를 바꾸지 않는다.
## 한국어 말하기 검사
@@ -38,7 +63,7 @@ description: Use when a Korean technical blog or reader-facing document should r
## 경험과 사실의 경계
코드 비교, 실행, 요청 추적처럼 실제로 수행한 작업은 1인칭으로 서술할 수 있다. 사용자가 경험담 문체를 요구했다면 이 관점을 제거하지 않는다.
코드 작성, 코드 비교, 실행, 요청 추적처럼 실제로 수행한 작업은 1인칭으로 서술할 수 있다. 사용자가 경험담 문체를 요구했다면 이 관점을 제거하지 않는다. 다만 코드를 만든 경험을 저장소를 처음 분석한 경험으로 바꾸지 않는다.
다만 근거에 없는 감정, 대화, 조언, 실패, 성과, 작업 기간은 만들지 않는다. `놀랐습니다`, `누군가 조언했습니다`, `며칠이 걸렸습니다`처럼 확인할 수 없는 경험은 추가하지 않는다. 기술 선택의 이유도 새로 만들지 않는다.
@@ -52,17 +77,20 @@ description: Use when a Korean technical blog or reader-facing document should r
## 수정 절차
1. 앞뒤 문단까지 읽고 작성자가 실제로 확인한 코드, 실행 결과와 판단을 찾는다.
2. 독자가 경험을 따라갈 시작점과 `그런데` 뒤에 놓을 발견을 고른다.
3. 주요 절을 1인칭 경험으로 열고, 기술 동작은 구체적인 구성요소와 동사로 설명한다.
4. 낯선 용어를 처음 필요한 문장 옆에서 풀어 쓴다.
5. 대조 문장은 소리 내어 읽고 `실제로는 무엇이 다른가`에 바로 답하는지 확인한다.
6. 파일을 직접 수정한 뒤 사실, 조건, 불확실성이 바뀌지 않았는지 비교한다.
1. 사용자 요청과 문서에서 코드 소유 관계를 확인하고 서술자를 작성자 또는 외부 분석자로 고정한다.
2. 앞뒤 문단까지 읽고 작성자가 실제로 구현하거나 확인한 코드, 실행 결과와 판단을 찾는다.
3. 독자가 경험을 따라갈 시작점과 `그런데` 뒤에 놓을 발견을 고른다.
4. 주요 절을 1인칭 경험으로 열고, 기술 동작은 구체적인 구성요소와 동사로 설명한다.
5. 낯선 용어를 처음 필요한 문장 옆에서 풀어 쓴다.
6. 대조 문장은 소리 내어 읽고 `실제로는 무엇이 다른가`에 바로 답하는지 확인한다.
7. 파일을 직접 수정한 뒤 사실, 조건, 불확실성이 바뀌지 않았는지 비교한다.
## 완료 조건
- 작성자의 시작점, 발견, 행동과 결과가 보인다.
- 코드 작성자의 문서가 외부 분석자의 저장소 검토처럼 읽히지 않는다.
- 단순한 객관식 해설이나 결론 목록으로 읽히지 않는다.
- 필요한 곳에서 `저는`이나 `제가`가 실제 서술 관점을 만든다.
- 사용자 예시와 같은 높임말이 독자용 본문 전체에서 유지된다.
- 한국인 개발자가 동료에게 설명할 때 쓸 수 있는 문장으로 읽힌다.
- 기술적 의미와 문서 구조가 그대로 남는다.
@@ -27,6 +27,20 @@
여기서는 `호출 주체가 다르다`를 구성요소 이름으로 바꾸는 데서 멈추지 않는다. 작성자가 같은 화면을 보고, 예상과 다른 요청을 발견하고, 낯선 값을 이해한 뒤, 각 구성요소를 확인한 순서로 문단 전체를 다시 쓴다.
## 작성자와 외부 분석자를 바꾸지 않는다
사용자가 자신이 만든 코드를 설명한다면 다음 문장은 관점이 잘못됐다.
수정 전:
> 처음 저장소를 열었을 때 19개 모듈이 먼저 보였습니다. 각 빌드 파일을 따라가 보니 코어의 클래스패스를 제한하는 구조였습니다.
수정 후:
> 코어에서 금지한 프레임워크 타입이 보이지 않게 하려고 클래스패스를 모듈마다 나눴습니다. 선택형 어댑터까지 분리한 결과 19개 모듈이 됐습니다.
작성자는 자신의 코드를 `열어 보고`, `훑어 보고`, `따라가며 발견한` 사람처럼 말하지 않는다. 만들 때 해결하려 한 문제, 정한 기준, 구현한 방법, 아직 연결하지 않은 범위와 받아들인 비용을 설명한다. 반대로 소유 관계를 알 수 없는 문서에 작성자 경험을 새로 붙이지 않는다.
## 한국어에서는 실제 차이를 바로 말한다
수정 전:
@@ -57,7 +71,7 @@
수정 후:
> AP1과 AP2에서는 브라우저가 API를 직접 부다. AP3에서는 BFF가 대신 호출하고, AP4에서는 Nginx가 요청을 이어 다.
> AP1과 AP2에서는 브라우저가 API를 직접 부릅니다. AP3에서는 BFF가 대신 호출하고, AP4에서는 Nginx가 요청을 이어 갑니다.
`호출 주체가 다르다`고 분류하지 말고 실제 구성요소와 행동을 쓴다.
@@ -69,7 +83,7 @@
수정 후:
> 그래서 패턴 이름만 보고 구현되지 않은 운영 속성을 덧붙이면 안 다.
> 그래서 패턴 이름만 보고 구현되지 않은 운영 속성을 덧붙이면 안 됩니다.
실제 순서를 뜻하지 않는 `첫 번째`, `두 번째`, `마지막`은 제거한다. 절차, 화면, 레이어처럼 순서 자체가 정보라면 유지한다.
@@ -81,7 +95,7 @@
수정 후:
> 브라우저가 Resource Server를 직접 부르는 방식은 유지해야 했다. 다만 client secret과 refresh token까지 JavaScript에 맡길 수는 없었다. 그래서 code 교환과 refresh token 보관은 confidential mediator가 맡았다.
> 브라우저가 Resource Server를 직접 부르는 방식은 유지해야 했습니다. 다만 client secret과 refresh token까지 JavaScript에 맡길 수는 없었습니다. 그래서 code 교환과 refresh token 보관은 confidential mediator가 맡았습니다.
`상황`, `선택`, `대안`, `가드레일`을 주어로 삼지 않는다. 그 자리에 요구, 행동, 이유, 남은 비용을 넣는다.
@@ -89,9 +103,9 @@
용어를 삭제하거나 모두 번역하지 않는다. 처음 이해가 필요한 지점에서만 짧게 푼다.
> 포팅은 코드를 다른 언어로 옮겨 다시 만드는 일다.
> 포팅은 코드를 다른 언어로 옮겨 다시 만드는 일입니다.
> authorized client는 로그인한 사용자와 OAuth client에 연결된 token 묶음다.
> authorized client는 로그인한 사용자와 OAuth client에 연결된 token 묶음입니다.
뒤 문장에서 이미 행동으로 뜻이 드러나면 별도의 정의를 반복하지 않는다.
File diff suppressed because it is too large Load Diff
+2 -2
View File
@@ -4,6 +4,6 @@ Processing /home/donghyeon/workspace/ai-tool/document-haness
Building wheels for collected packages: claridoc-harness
Building wheel for claridoc-harness (pyproject.toml): started
Building wheel for claridoc-harness (pyproject.toml): finished with status 'done'
Created wheel for claridoc-harness: filename=claridoc_harness-0.2.0-py3-none-any.whl size=193673 sha256=9a5dddeee5df1fb98ae949c56213b1f6ff0143b3b5eb31f541eeb1f907ebbf83
Stored in directory: /tmp/pip-ephem-wheel-cache-04qw0e2v/wheels/35/8c/5a/14e7d960f0df960a7b2711bf02a47dcdc5925d278104863c49
Created wheel for claridoc-harness: filename=claridoc_harness-0.2.0-py3-none-any.whl size=212405 sha256=a8eb8563b280593146c32b52e1ee00d7bfe4e9ca312988d2d7cf72a8f847e004
Stored in directory: /tmp/pip-ephem-wheel-cache-5wc_0dhn/wheels/35/8c/5a/14e7d960f0df960a7b2711bf02a47dcdc5925d278104863c49
Successfully built claridoc-harness
+1
View File
@@ -14,6 +14,7 @@ class ValidationError(ValueError):
class DocumentType(str, Enum):
TECHNICAL_BLOG = "technical_blog"
README = "readme"
TUTORIAL = "tutorial"
HOW_TO = "how_to"
EXPLANATION = "explanation"
+10
View File
@@ -32,6 +32,16 @@ STRUCTURE_SPECS: dict[DocumentType, tuple[SectionSpec, ...]] = {
S("tradeoffs", "얻은 것, 잃은 것, 적용하지 않을 때", "What was gained, lost, and when not to apply it", "이 선택의 비용과 한계는 무엇이며 언제 다른 선택이 나은가?", "What are the costs and limits, and when is another choice better?", "프로젝트 지역 결정을 보편 법칙처럼 쓰지 않고, 적용 조건과 남은 위험을 제시한다.", "Do not universalize a project-local decision; state applicability and remaining risks.", ("얻은 것", "잃은 것", "적용 조건", "남은 위험"), ("gains", "costs", "applicability", "remaining risks")),
S("conclusion", "결국 지키려던 것은 무엇이었나", "What the design was ultimately protecting", "세부 기술을 걷어냈을 때 남는 판단은 무엇인가?", "What judgment remains after removing implementation detail?", "앞 내용을 반복하지 않고, 문제와 선택을 연결하는 한 문장 판단으로 닫는다.", "Close with a compact judgment that reconnects the problem and choice without repetition.", ("압축된 판단", "독자가 자신의 환경에서 확인할 질문"), ("compressed judgment", "question for the reader's environment")),
),
DocumentType.README: (
S("problem_value", "이 프로젝트가 필요한 이유", "Why this project exists", "어떤 구체적인 문제를 해결하며 왜 이 프로젝트가 필요한가?", "What concrete problem does this project solve, and why does it exist?", "독자가 겪는 문제와 프로젝트가 제공하는 가치를 실제 상황에서 설명한다.", "Explain the reader's problem and the project's value through a concrete situation.", ("문제 상황", "프로젝트 가치", "대상 독자"), ("problem context", "project value", "intended reader")),
S("principles", "동작 원칙과 지키는 경계", "Operating principles and boundaries", "사용 전에 알아야 할 핵심 원칙과 경계는 무엇인가?", "Which principles and boundaries must readers understand before use?", "프로젝트가 보장하는 동작과 의도적으로 보장하지 않는 범위를 구분한다.", "Separate guaranteed behavior from deliberately unsupported scope.", ("핵심 원칙", "보장 범위", "비보장 범위"), ("core principles", "guarantees", "non-guarantees")),
S("workflow", "전체 동작 흐름", "End-to-end workflow", "입력부터 결과와 검증 기록까지 어떤 순서로 진행되는가?", "How does work proceed from input to output and verification artifacts?", "주요 구성요소와 산출물이 이어지는 전체 흐름을 보여 준다.", "Show the end-to-end flow connecting components and artifacts.", ("입력", "주요 단계", "독자용 결과", "내부 산출물"), ("inputs", "main stages", "reader output", "internal artifacts")),
S("installation", "설치와 시작 전 준비", "Installation and prerequisites", "실행 전에 무엇을 설치하고 준비해야 하는가?", "What must be installed and prepared before use?", "지원 버전, 필수 도구, 설치 명령과 초기 상태를 설명한다.", "Explain supported versions, required tools, installation commands, and initial state.", ("지원 버전", "필수 도구", "설치 명령"), ("supported versions", "required tools", "installation commands")),
S("quickstart", "가장 작은 실행 예시", "Smallest useful run", "가장 짧은 경로로 어떤 유용한 결과를 확인할 수 있는가?", "What useful result can be observed through the shortest path?", "복사 가능한 최소 명령과 예상 결과, 확인 지점을 제공한다.", "Provide the smallest copyable command, expected result, and verification point.", ("최소 입력", "실행 명령", "예상 결과", "확인 방법"), ("minimal input", "run command", "expected result", "verification")),
S("configuration", "주요 설정과 선택 기준", "Configuration and selection criteria", "어떤 설정을 언제 선택하며 결과에 어떤 영향을 주는가?", "Which settings should be chosen when, and how do they affect the result?", "핵심 설정의 기본값, 선택 조건, 비용과 제한을 연결한다.", "Connect key configuration defaults to selection criteria, costs, and limits.", ("설정 항목", "기본값", "선택 조건", "영향"), ("settings", "defaults", "selection criteria", "effects")),
S("verification", "검증과 문제 확인", "Verification and diagnosis", "성공을 어떻게 확인하고 대표적인 실패를 어떻게 좁히는가?", "How is success verified and common failure narrowed down?", "관측 가능한 성공 기준과 비파괴 진단 경로를 제공한다.", "Provide observable success criteria and a non-destructive diagnostic path.", ("성공 기준", "확인 명령", "대표 실패 신호", "진단 경로"), ("success criteria", "check command", "failure signal", "diagnostic path")),
S("limits_next", "한계와 다음 행동", "Limits and next action", "어디까지 검증되었으며 다음에 무엇을 해야 하는가?", "What has been verified, where are the limits, and what comes next?", "근거 한계와 비지원 범위를 밝히고 직접 연결된 다음 행동으로 닫는다.", "State evidence limits and unsupported scope, then close with the next directly related action.", ("검증 범위", "한계", "비지원 항목", "다음 행동"), ("verified scope", "limits", "unsupported items", "next action")),
),
DocumentType.TUTORIAL: (
S("outcome", "완성 결과와 학습 목표", "Outcome and learning objective", "끝에서 무엇을 만들고 무엇을 배우는가?", "What will be built and learned?", "가시적인 결과와 학습 목표를 먼저 보여준다.", "Show the visible outcome and learning objective first.", ("완성 상태", "학습 목표", "예상 소요 범위"), ("finished state", "learning objective", "expected effort")),
S("prerequisites", "시작 전 준비 사항", "Prerequisites", "시작 전에 무엇이 준비되어야 하는가?", "What must be ready before starting?", "필요 지식, 도구, 버전, 초기 상태를 명시한다.", "State required knowledge, tools, versions, and initial state.", ("지식", "도구와 버전", "초기 상태"), ("knowledge", "tools and versions", "initial state")),
+1 -1
View File
@@ -1 +1 @@
9a5dddeee5df1fb98ae949c56213b1f6ff0143b3b5eb31f541eeb1f907ebbf83 claridoc_harness-0.2.0-py3-none-any.whl
a8eb8563b280593146c32b52e1ee00d7bfe4e9ca312988d2d7cf72a8f847e004 claridoc_harness-0.2.0-py3-none-any.whl
Binary file not shown.
@@ -1,6 +1,6 @@
{
"schema_version": 1,
"created_at": "2026-07-29T07:45:31+00:00",
"created_at": "2026-07-29T09:23:39+00:00",
"files": [
{
"path": "final/document.md",
@@ -40,7 +40,7 @@
{
"path": "provider-events.jsonl",
"bytes": 2788,
"sha256": "2a88c5b7d5d75e11ee2017c06099582b7288d1d625c92398b457edac82344037"
"sha256": "cebfe8a1d50135a84968341712d4b1b63a492c4bd47d239bffdb2a3bbb140431"
},
{
"path": "rounds/round-01/draft.md",
@@ -125,7 +125,7 @@
{
"path": "run.json",
"bytes": 1112,
"sha256": "af0dd9cbd07f6caa9ed27487f04ce0ca1e97b39550ba1a6cc9fc9936ace442e2"
"sha256": "eff4efefd44cb67bf0ff46526787ec49c0efae65fb682b37486aa58e13a7fe39"
},
{
"path": "stages/01-planner.raw.txt",
@@ -1,16 +1,16 @@
{"at": "2026-07-29T07:45:31+00:00", "stage": "plan", "provider": "mock", "model": "", "metadata": {"document_type": "technical_blog"}, "status": "started"}
{"at": "2026-07-29T07:45:31+00:00", "stage": "plan", "provider": "mock", "model": "", "metadata": {"document_type": "technical_blog"}, "status": "completed", "duration_ms": 0.4, "response_characters": 5367, "command": []}
{"at": "2026-07-29T07:45:31+00:00", "stage": "draft", "provider": "mock", "model": "", "metadata": {}, "status": "started"}
{"at": "2026-07-29T07:45:31+00:00", "stage": "draft", "provider": "mock", "model": "", "metadata": {}, "status": "completed", "duration_ms": 0.4, "response_characters": 2786, "command": []}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "logic"}, "status": "started"}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "logic"}, "status": "completed", "duration_ms": 0.3, "response_characters": 571, "command": []}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "decision"}, "status": "started"}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "decision"}, "status": "completed", "duration_ms": 0.3, "response_characters": 574, "command": []}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "reader"}, "status": "started"}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "reader"}, "status": "completed", "duration_ms": 0.3, "response_characters": 572, "command": []}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "editor"}, "status": "started"}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "editor"}, "status": "completed", "duration_ms": 0.3, "response_characters": 572, "command": []}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "evidence"}, "status": "started"}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "evidence"}, "status": "completed", "duration_ms": 0.3, "response_characters": 574, "command": []}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "operations"}, "status": "started"}
{"at": "2026-07-29T07:45:31+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "operations"}, "status": "completed", "duration_ms": 0.3, "response_characters": 576, "command": []}
{"at": "2026-07-29T09:23:39+00:00", "stage": "plan", "provider": "mock", "model": "", "metadata": {"document_type": "technical_blog"}, "status": "started"}
{"at": "2026-07-29T09:23:39+00:00", "stage": "plan", "provider": "mock", "model": "", "metadata": {"document_type": "technical_blog"}, "status": "completed", "duration_ms": 0.7, "response_characters": 5367, "command": []}
{"at": "2026-07-29T09:23:39+00:00", "stage": "draft", "provider": "mock", "model": "", "metadata": {}, "status": "started"}
{"at": "2026-07-29T09:23:39+00:00", "stage": "draft", "provider": "mock", "model": "", "metadata": {}, "status": "completed", "duration_ms": 0.8, "response_characters": 2786, "command": []}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "logic"}, "status": "started"}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "logic"}, "status": "completed", "duration_ms": 0.4, "response_characters": 571, "command": []}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "decision"}, "status": "started"}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "decision"}, "status": "completed", "duration_ms": 0.4, "response_characters": 574, "command": []}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "reader"}, "status": "started"}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "reader"}, "status": "completed", "duration_ms": 0.7, "response_characters": 572, "command": []}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "editor"}, "status": "started"}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "editor"}, "status": "completed", "duration_ms": 0.4, "response_characters": 572, "command": []}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "evidence"}, "status": "started"}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "evidence"}, "status": "completed", "duration_ms": 0.4, "response_characters": 574, "command": []}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "operations"}, "status": "started"}
{"at": "2026-07-29T09:23:39+00:00", "stage": "review", "provider": "mock", "model": "", "metadata": {"role": "operations"}, "status": "completed", "duration_ms": 0.4, "response_characters": 576, "command": []}
+1 -1
View File
@@ -1,6 +1,6 @@
{
"schema_version": 1,
"created_at": "2026-07-29T07:45:31+00:00",
"created_at": "2026-07-29T09:23:39+00:00",
"document": "API 재시도는 횟수가 아니라 부하 예산으로 설계한다",
"document_type": "technical_blog",
"passed": true,
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
+32
View File
@@ -13,6 +13,11 @@ from claridoc.models import (
Severity,
SourcePack,
)
from claridoc.style_contracts import (
KOREAN_EXPERIENCE_CONTRACT_ID,
korean_experience_contract_applies,
plain_form_ending_locations,
)
from claridoc.utils import line_number, normalize_heading, strip_code_blocks, word_count
@@ -201,6 +206,27 @@ def lint_document(text: str, brief: Brief, outline: Outline, sources: SourcePack
),
)
break
style_contract_applies = korean_experience_contract_applies(brief)
plain_form_locations = (
plain_form_ending_locations(text)
if style_contract_applies
else []
)
if plain_form_locations:
add(
"STYLE002",
Severity.BLOCKER,
(
"Reader-facing Korean prose mixes plain declarative endings "
f"into the required 합니다/했습니다 style ({len(plain_form_locations)} occurrence(s))."
),
line=plain_form_locations[0],
suggestion=(
"Use 했습니다 for observed or performed work and 합니다 for "
"current behavior. Preserve quoted material and code unchanged."
),
)
long_paragraph_count = 0
crowded_paragraph_count = 0
long_sentence_count = 0
@@ -398,6 +424,12 @@ def lint_document(text: str, brief: Brief, outline: Outline, sources: SourcePack
"decision_section_count": sum(bool(section.decision_requirements) for section in outline.sections),
"numbered_steps": numbered_steps,
"formulaic_ordinal_opening_count": len(formulaic_ordinal_openings),
"style_contract": (
KOREAN_EXPERIENCE_CONTRACT_ID
if style_contract_applies
else "none"
),
"plain_form_ending_count": len(plain_form_locations),
"has_verification": has_verification,
"has_tradeoffs": has_tradeoffs,
"severity_counts": dict(severity_counts),
+87
View File
@@ -1,5 +1,8 @@
from __future__ import annotations
import re
from dataclasses import dataclass
from claridoc.models import Brief, DocumentType
@@ -35,6 +38,29 @@ Write Korean reader-facing prose as a supported first-person experience, not as
- Use conversational but disciplined Korean. A Korean developer should be able to say the sentence naturally to a colleague without turning it into forced colloquial speech.
"""
_PLAIN_FORM_ENDING = re.compile(r"(?<!니)다(?=[.!?](?:\s|$))")
_FENCE = re.compile(r"^\s*(?:```|~~~)")
_HEADING = re.compile(r"^\s{0,3}(#{1,6})\s+(.+?)\s*$")
_IMAGE_ONLY = re.compile(r"^\s*!\[[^\]]*\]\([^)]*\)\s*$")
_TABLE_DIVIDER = re.compile(
r"^\s*\|?\s*:?-{3,}:?\s*(?:\|\s*:?-{3,}:?\s*)+\|?\s*$"
)
_QUOTED_SPANS = (
re.compile(r'"[^"\n]*"'),
re.compile(r"'[^'\n]*'"),
re.compile(r"“[^”\n]*”"),
re.compile(r"[^\n]*"),
re.compile(r"「[^」\n]*」"),
re.compile(r"『[^』\n]*』"),
)
@dataclass(frozen=True, slots=True)
class ReaderProseSegment:
text: str
line: int
h2_title: str | None
def korean_experience_contract_applies(brief: Brief) -> bool:
if not brief.is_korean:
@@ -72,3 +98,64 @@ def revision_style_protocol(brief: Brief) -> str:
After resolving individual findings, recheck 문서 전체(the complete document) against `korean_first_person_experience_v1`.
Do not stop after adding one `저는` sentence. Confirm the opening and major transitions still form supported experience threads, all reader prose still uses `합니다/했습니다`, unfamiliar terms remain explained at first need, and no compliant section regressed during the whole-document rewrite.
"""
def reader_prose_segments(markdown: str) -> list[ReaderProseSegment]:
segments: list[ReaderProseSegment] = []
in_fence = False
current_h2: str | None = None
lines = markdown.splitlines()
table_lines: set[int] = set()
for index, line in enumerate(lines):
if not _TABLE_DIVIDER.match(line):
continue
if index > 0 and "|" in lines[index - 1]:
table_lines.add(index - 1)
table_lines.add(index)
cursor = index + 1
while cursor < len(lines) and lines[cursor].strip() and "|" in lines[cursor]:
table_lines.add(cursor)
cursor += 1
for line_number, raw_line in enumerate(lines, start=1):
if _FENCE.match(raw_line):
in_fence = not in_fence
continue
if in_fence:
continue
heading = _HEADING.match(raw_line)
if heading:
if len(heading.group(1)) == 2:
current_h2 = heading.group(2).strip()
continue
stripped = raw_line.strip()
if (
not stripped
or line_number - 1 in table_lines
or stripped.startswith(">")
or raw_line.startswith((" ", "\t"))
or _IMAGE_ONLY.match(raw_line)
or _TABLE_DIVIDER.match(raw_line)
or (stripped.startswith("|") and stripped.endswith("|"))
):
continue
prose = re.sub(r"!\[[^\]]*\]\([^)]*\)", "", stripped)
prose = re.sub(r"\[([^\]]+)\]\([^)]*\)", r"\1", prose)
prose = re.sub(r"`[^`\n]*`", "", prose)
for quoted_span in _QUOTED_SPANS:
prose = quoted_span.sub("", prose)
prose = re.sub(r"^\s*(?:[-*+]|\d+[.)])\s+", "", prose).strip()
if prose:
segments.append(ReaderProseSegment(prose, line_number, current_h2))
return segments
def plain_form_ending_locations(markdown: str) -> list[int]:
locations: list[int] = []
for segment in reader_prose_segments(markdown):
locations.extend(segment.line for _ in _PLAIN_FORM_ENDING.finditer(segment.text))
return locations
+393
View File
@@ -1,9 +1,270 @@
AGENTS.md
CHANGELOG.md
CLAUDE.md
LICENSE
Makefile
PACKAGE_MANIFEST.json
README.md
pyproject.toml
.agents/skills/revising-korean-technical-prose/SKILL.md
.agents/skills/revising-korean-technical-prose/agents/openai.yaml
.agents/skills/revising-korean-technical-prose/references/sentence-patterns.md
.run/executable-clean-architecture/assets/architecture-layered-2026-07-04.svg
.run/executable-clean-architecture/assets/architecture-three-lenses.svg
.run/executable-clean-architecture/assets/big-picture.svg
.run/executable-clean-architecture/assets/boundary-enforcement-ladder.svg
.run/executable-clean-architecture/assets/context-system-boundary.svg
.run/executable-clean-architecture/assets/decision-spectrum-1.svg
.run/executable-clean-architecture/assets/decision-spectrum-3.svg
.run/executable-clean-architecture/assets/enforcement-ladder.svg
.run/executable-clean-architecture/assets/hexagonal-ports.svg
.run/executable-clean-architecture/assets/idempotency-four-branches.svg
.run/executable-clean-architecture/assets/lock-timeout-routing-gap.svg
.run/executable-clean-architecture/assets/logical-four-rings.svg
.run/executable-clean-architecture/assets/mdc-request-lifecycle.svg
.run/executable-clean-architecture/assets/module-graph-measured.svg
.run/executable-clean-architecture/assets/module-vs-single.svg
.run/executable-clean-architecture/assets/outbox-state-machine.svg
.run/executable-clean-architecture/assets/outbox-two-paths.svg
.run/executable-clean-architecture/assets/production-vs-optin.drawio
.run/executable-clean-architecture/assets/production-vs-optin.svg
.run/executable-clean-architecture/assets/runtime-call-source-dependency.svg
.run/executable-clean-architecture/assets/runtime-seq-feed.svg
.run/executable-clean-architecture/assets/static-analysis-venn.svg
.run/executable-clean-architecture/assets/test-contrast.svg
.run/executable-clean-architecture/assets/test-taxonomy-layers.svg
.run/executable-clean-architecture/assets/three-gate-flow.svg
.run/executable-clean-architecture/assets/transaction-lock-independent-contracts.svg
.run/executable-clean-architecture/assets/bootstrap-dependency-guards/bootstrap-dependency-guards.svg
.run/executable-clean-architecture/assets/inbound-transport-boundary/inbound-transport-boundary.svg
.run/executable-clean-architecture/final/document.md
.run/executable-clean-architecture/final/.techviz/production-vs-optin/spec.json
.run/keycloak-four-patterns/brief.json
.run/keycloak-four-patterns/collected.develop.json
.run/keycloak-four-patterns/manifest.json
.run/keycloak-four-patterns/outline.json
.run/keycloak-four-patterns/outline.preliminary.json
.run/keycloak-four-patterns/sources.json
.run/keycloak-four-patterns/sources.manual.json
.run/keycloak-four-patterns/final/deterministic-lint.md
.run/keycloak-four-patterns/final/document.md
.run/keycloak-four-patterns/final/evidence-map.json
.run/keycloak-four-patterns/final/provenance.md
.run/keycloak-four-patterns/final/quality-report.md
.run/keycloak-four-patterns/final/.techviz/ap1-browser-bearer-flow/context.json
.run/keycloak-four-patterns/final/.techviz/ap1-browser-bearer-flow/prompt.md
.run/keycloak-four-patterns/final/.techviz/ap1-browser-bearer-flow/spec.json
.run/keycloak-four-patterns/final/.techviz/ap1-direct-architecture/context.json
.run/keycloak-four-patterns/final/.techviz/ap1-direct-architecture/prompt.md
.run/keycloak-four-patterns/final/.techviz/ap1-direct-architecture/spec.json
.run/keycloak-four-patterns/final/.techviz/ap2-mediator-architecture/context.json
.run/keycloak-four-patterns/final/.techviz/ap2-mediator-architecture/prompt.md
.run/keycloak-four-patterns/final/.techviz/ap2-mediator-architecture/spec.json
.run/keycloak-four-patterns/final/.techviz/ap2-mediator-handoff-flow/context.json
.run/keycloak-four-patterns/final/.techviz/ap2-mediator-handoff-flow/prompt.md
.run/keycloak-four-patterns/final/.techviz/ap2-mediator-handoff-flow/spec.json
.run/keycloak-four-patterns/final/.techviz/ap3-bff-architecture/context.json
.run/keycloak-four-patterns/final/.techviz/ap3-bff-architecture/prompt.md
.run/keycloak-four-patterns/final/.techviz/ap3-bff-architecture/spec.json
.run/keycloak-four-patterns/final/.techviz/ap3-bff-session-flow/context.json
.run/keycloak-four-patterns/final/.techviz/ap3-bff-session-flow/prompt.md
.run/keycloak-four-patterns/final/.techviz/ap3-bff-session-flow/spec.json
.run/keycloak-four-patterns/final/.techviz/ap3-csrf-boundary/context.json
.run/keycloak-four-patterns/final/.techviz/ap3-csrf-boundary/prompt.md
.run/keycloak-four-patterns/final/.techviz/ap3-csrf-boundary/spec.json
.run/keycloak-four-patterns/final/.techviz/ap4-edge-forward-auth-flow/context.json
.run/keycloak-four-patterns/final/.techviz/ap4-edge-forward-auth-flow/prompt.md
.run/keycloak-four-patterns/final/.techviz/ap4-edge-forward-auth-flow/spec.json
.run/keycloak-four-patterns/final/.techviz/ap4-edge-trust-architecture/context.json
.run/keycloak-four-patterns/final/.techviz/ap4-edge-trust-architecture/prompt.md
.run/keycloak-four-patterns/final/.techviz/ap4-edge-trust-architecture/spec.json
.run/keycloak-four-patterns/final/.techviz/credential-contract-migration/context.json
.run/keycloak-four-patterns/final/.techviz/credential-contract-migration/prompt.md
.run/keycloak-four-patterns/final/.techviz/credential-contract-migration/spec.json
.run/keycloak-four-patterns/final/.techviz/credential-custody-map/context.json
.run/keycloak-four-patterns/final/.techviz/credential-custody-map/prompt.md
.run/keycloak-four-patterns/final/.techviz/credential-custody-map/spec.json
.run/keycloak-four-patterns/final/.techviz/four-pattern-request-boundaries/context.json
.run/keycloak-four-patterns/final/.techviz/four-pattern-request-boundaries/prompt.md
.run/keycloak-four-patterns/final/.techviz/four-pattern-request-boundaries/spec.json
.run/keycloak-four-patterns/final/.techviz/login-api-phase-split/context.json
.run/keycloak-four-patterns/final/.techviz/login-api-phase-split/prompt.md
.run/keycloak-four-patterns/final/.techviz/login-api-phase-split/spec.json
.run/keycloak-four-patterns/final/assets/ap1-browser-bearer-flow/ap1-browser-bearer-flow.alt.md
.run/keycloak-four-patterns/final/assets/ap1-browser-bearer-flow/ap1-browser-bearer-flow.d2
.run/keycloak-four-patterns/final/assets/ap1-browser-bearer-flow/ap1-browser-bearer-flow.dot
.run/keycloak-four-patterns/final/assets/ap1-browser-bearer-flow/ap1-browser-bearer-flow.drawio
.run/keycloak-four-patterns/final/assets/ap1-browser-bearer-flow/ap1-browser-bearer-flow.excalidraw
.run/keycloak-four-patterns/final/assets/ap1-browser-bearer-flow/ap1-browser-bearer-flow.manifest.json
.run/keycloak-four-patterns/final/assets/ap1-browser-bearer-flow/ap1-browser-bearer-flow.mmd
.run/keycloak-four-patterns/final/assets/ap1-browser-bearer-flow/ap1-browser-bearer-flow.svg
.run/keycloak-four-patterns/final/assets/ap1-direct-architecture/ap1-direct-architecture.alt.md
.run/keycloak-four-patterns/final/assets/ap1-direct-architecture/ap1-direct-architecture.d2
.run/keycloak-four-patterns/final/assets/ap1-direct-architecture/ap1-direct-architecture.dot
.run/keycloak-four-patterns/final/assets/ap1-direct-architecture/ap1-direct-architecture.drawio
.run/keycloak-four-patterns/final/assets/ap1-direct-architecture/ap1-direct-architecture.excalidraw
.run/keycloak-four-patterns/final/assets/ap1-direct-architecture/ap1-direct-architecture.manifest.json
.run/keycloak-four-patterns/final/assets/ap1-direct-architecture/ap1-direct-architecture.mmd
.run/keycloak-four-patterns/final/assets/ap1-direct-architecture/ap1-direct-architecture.svg
.run/keycloak-four-patterns/final/assets/ap2-mediator-architecture/ap2-mediator-architecture.alt.md
.run/keycloak-four-patterns/final/assets/ap2-mediator-architecture/ap2-mediator-architecture.d2
.run/keycloak-four-patterns/final/assets/ap2-mediator-architecture/ap2-mediator-architecture.dot
.run/keycloak-four-patterns/final/assets/ap2-mediator-architecture/ap2-mediator-architecture.drawio
.run/keycloak-four-patterns/final/assets/ap2-mediator-architecture/ap2-mediator-architecture.excalidraw
.run/keycloak-four-patterns/final/assets/ap2-mediator-architecture/ap2-mediator-architecture.manifest.json
.run/keycloak-four-patterns/final/assets/ap2-mediator-architecture/ap2-mediator-architecture.mmd
.run/keycloak-four-patterns/final/assets/ap2-mediator-architecture/ap2-mediator-architecture.svg
.run/keycloak-four-patterns/final/assets/ap2-mediator-handoff-flow/ap2-mediator-handoff-flow.alt.md
.run/keycloak-four-patterns/final/assets/ap2-mediator-handoff-flow/ap2-mediator-handoff-flow.d2
.run/keycloak-four-patterns/final/assets/ap2-mediator-handoff-flow/ap2-mediator-handoff-flow.dot
.run/keycloak-four-patterns/final/assets/ap2-mediator-handoff-flow/ap2-mediator-handoff-flow.drawio
.run/keycloak-four-patterns/final/assets/ap2-mediator-handoff-flow/ap2-mediator-handoff-flow.excalidraw
.run/keycloak-four-patterns/final/assets/ap2-mediator-handoff-flow/ap2-mediator-handoff-flow.manifest.json
.run/keycloak-four-patterns/final/assets/ap2-mediator-handoff-flow/ap2-mediator-handoff-flow.mmd
.run/keycloak-four-patterns/final/assets/ap2-mediator-handoff-flow/ap2-mediator-handoff-flow.svg
.run/keycloak-four-patterns/final/assets/ap3-bff-architecture/ap3-bff-architecture.alt.md
.run/keycloak-four-patterns/final/assets/ap3-bff-architecture/ap3-bff-architecture.d2
.run/keycloak-four-patterns/final/assets/ap3-bff-architecture/ap3-bff-architecture.dot
.run/keycloak-four-patterns/final/assets/ap3-bff-architecture/ap3-bff-architecture.drawio
.run/keycloak-four-patterns/final/assets/ap3-bff-architecture/ap3-bff-architecture.excalidraw
.run/keycloak-four-patterns/final/assets/ap3-bff-architecture/ap3-bff-architecture.manifest.json
.run/keycloak-four-patterns/final/assets/ap3-bff-architecture/ap3-bff-architecture.mmd
.run/keycloak-four-patterns/final/assets/ap3-bff-architecture/ap3-bff-architecture.svg
.run/keycloak-four-patterns/final/assets/ap3-bff-session-flow/ap3-bff-session-flow.alt.md
.run/keycloak-four-patterns/final/assets/ap3-bff-session-flow/ap3-bff-session-flow.d2
.run/keycloak-four-patterns/final/assets/ap3-bff-session-flow/ap3-bff-session-flow.dot
.run/keycloak-four-patterns/final/assets/ap3-bff-session-flow/ap3-bff-session-flow.drawio
.run/keycloak-four-patterns/final/assets/ap3-bff-session-flow/ap3-bff-session-flow.excalidraw
.run/keycloak-four-patterns/final/assets/ap3-bff-session-flow/ap3-bff-session-flow.manifest.json
.run/keycloak-four-patterns/final/assets/ap3-bff-session-flow/ap3-bff-session-flow.mmd
.run/keycloak-four-patterns/final/assets/ap3-bff-session-flow/ap3-bff-session-flow.svg
.run/keycloak-four-patterns/final/assets/ap3-csrf-boundary/ap3-csrf-boundary.alt.md
.run/keycloak-four-patterns/final/assets/ap3-csrf-boundary/ap3-csrf-boundary.d2
.run/keycloak-four-patterns/final/assets/ap3-csrf-boundary/ap3-csrf-boundary.dot
.run/keycloak-four-patterns/final/assets/ap3-csrf-boundary/ap3-csrf-boundary.drawio
.run/keycloak-four-patterns/final/assets/ap3-csrf-boundary/ap3-csrf-boundary.excalidraw
.run/keycloak-four-patterns/final/assets/ap3-csrf-boundary/ap3-csrf-boundary.manifest.json
.run/keycloak-four-patterns/final/assets/ap3-csrf-boundary/ap3-csrf-boundary.mmd
.run/keycloak-four-patterns/final/assets/ap3-csrf-boundary/ap3-csrf-boundary.svg
.run/keycloak-four-patterns/final/assets/ap4-edge-forward-auth-flow/ap4-edge-forward-auth-flow.alt.md
.run/keycloak-four-patterns/final/assets/ap4-edge-forward-auth-flow/ap4-edge-forward-auth-flow.d2
.run/keycloak-four-patterns/final/assets/ap4-edge-forward-auth-flow/ap4-edge-forward-auth-flow.dot
.run/keycloak-four-patterns/final/assets/ap4-edge-forward-auth-flow/ap4-edge-forward-auth-flow.drawio
.run/keycloak-four-patterns/final/assets/ap4-edge-forward-auth-flow/ap4-edge-forward-auth-flow.excalidraw
.run/keycloak-four-patterns/final/assets/ap4-edge-forward-auth-flow/ap4-edge-forward-auth-flow.manifest.json
.run/keycloak-four-patterns/final/assets/ap4-edge-forward-auth-flow/ap4-edge-forward-auth-flow.mmd
.run/keycloak-four-patterns/final/assets/ap4-edge-forward-auth-flow/ap4-edge-forward-auth-flow.svg
.run/keycloak-four-patterns/final/assets/ap4-edge-trust-architecture/ap4-edge-trust-architecture.alt.md
.run/keycloak-four-patterns/final/assets/ap4-edge-trust-architecture/ap4-edge-trust-architecture.d2
.run/keycloak-four-patterns/final/assets/ap4-edge-trust-architecture/ap4-edge-trust-architecture.dot
.run/keycloak-four-patterns/final/assets/ap4-edge-trust-architecture/ap4-edge-trust-architecture.drawio
.run/keycloak-four-patterns/final/assets/ap4-edge-trust-architecture/ap4-edge-trust-architecture.excalidraw
.run/keycloak-four-patterns/final/assets/ap4-edge-trust-architecture/ap4-edge-trust-architecture.manifest.json
.run/keycloak-four-patterns/final/assets/ap4-edge-trust-architecture/ap4-edge-trust-architecture.mmd
.run/keycloak-four-patterns/final/assets/ap4-edge-trust-architecture/ap4-edge-trust-architecture.svg
.run/keycloak-four-patterns/final/assets/credential-contract-migration/credential-contract-migration.alt.md
.run/keycloak-four-patterns/final/assets/credential-contract-migration/credential-contract-migration.d2
.run/keycloak-four-patterns/final/assets/credential-contract-migration/credential-contract-migration.dot
.run/keycloak-four-patterns/final/assets/credential-contract-migration/credential-contract-migration.drawio
.run/keycloak-four-patterns/final/assets/credential-contract-migration/credential-contract-migration.excalidraw
.run/keycloak-four-patterns/final/assets/credential-contract-migration/credential-contract-migration.manifest.json
.run/keycloak-four-patterns/final/assets/credential-contract-migration/credential-contract-migration.mmd
.run/keycloak-four-patterns/final/assets/credential-contract-migration/credential-contract-migration.svg
.run/keycloak-four-patterns/final/assets/credential-custody-map/credential-custody-map.alt.md
.run/keycloak-four-patterns/final/assets/credential-custody-map/credential-custody-map.d2
.run/keycloak-four-patterns/final/assets/credential-custody-map/credential-custody-map.dot
.run/keycloak-four-patterns/final/assets/credential-custody-map/credential-custody-map.drawio
.run/keycloak-four-patterns/final/assets/credential-custody-map/credential-custody-map.excalidraw
.run/keycloak-four-patterns/final/assets/credential-custody-map/credential-custody-map.manifest.json
.run/keycloak-four-patterns/final/assets/credential-custody-map/credential-custody-map.mmd
.run/keycloak-four-patterns/final/assets/credential-custody-map/credential-custody-map.svg
.run/keycloak-four-patterns/final/assets/four-pattern-request-boundaries/four-pattern-request-boundaries.alt.md
.run/keycloak-four-patterns/final/assets/four-pattern-request-boundaries/four-pattern-request-boundaries.d2
.run/keycloak-four-patterns/final/assets/four-pattern-request-boundaries/four-pattern-request-boundaries.dot
.run/keycloak-four-patterns/final/assets/four-pattern-request-boundaries/four-pattern-request-boundaries.drawio
.run/keycloak-four-patterns/final/assets/four-pattern-request-boundaries/four-pattern-request-boundaries.excalidraw
.run/keycloak-four-patterns/final/assets/four-pattern-request-boundaries/four-pattern-request-boundaries.manifest.json
.run/keycloak-four-patterns/final/assets/four-pattern-request-boundaries/four-pattern-request-boundaries.mmd
.run/keycloak-four-patterns/final/assets/four-pattern-request-boundaries/four-pattern-request-boundaries.svg
.run/keycloak-four-patterns/final/assets/login-api-phase-split/login-api-phase-split.alt.md
.run/keycloak-four-patterns/final/assets/login-api-phase-split/login-api-phase-split.d2
.run/keycloak-four-patterns/final/assets/login-api-phase-split/login-api-phase-split.dot
.run/keycloak-four-patterns/final/assets/login-api-phase-split/login-api-phase-split.drawio
.run/keycloak-four-patterns/final/assets/login-api-phase-split/login-api-phase-split.excalidraw
.run/keycloak-four-patterns/final/assets/login-api-phase-split/login-api-phase-split.manifest.json
.run/keycloak-four-patterns/final/assets/login-api-phase-split/login-api-phase-split.mmd
.run/keycloak-four-patterns/final/assets/login-api-phase-split/login-api-phase-split.svg
.run/n+1liner/final/document.md
.run/n+1liner/final/.techviz/baseline-schema/spec.json
.run/n+1liner/final/.techviz/eager-lazy-query-sequence/spec.json
.run/n+1liner/final/.techviz/nplus1-query-fanout/spec.json
.run/n+1liner/final/.techviz/query-port-boundary/spec.json
.run/n+1liner/final/.techviz/skew-profile/spec.json
.run/n+1liner/final/.techviz/strategy-journey/spec.json
.run/n+1liner/final/.techviz/target-schema/spec.json
.run/n+1liner/final/assets/README.md
.run/n+1liner/final/assets/diagrams/baseline-schema/baseline-schema.drawio
.run/n+1liner/final/assets/diagrams/baseline-schema/baseline-schema.svg
.run/n+1liner/final/assets/diagrams/eager-lazy-query-sequence/eager-lazy-query-sequence.drawio
.run/n+1liner/final/assets/diagrams/eager-lazy-query-sequence/eager-lazy-query-sequence.svg
.run/n+1liner/final/assets/diagrams/nplus1-query-fanout/nplus1-query-fanout.drawio
.run/n+1liner/final/assets/diagrams/nplus1-query-fanout/nplus1-query-fanout.svg
.run/n+1liner/final/assets/diagrams/query-port-boundary/query-port-boundary.drawio
.run/n+1liner/final/assets/diagrams/query-port-boundary/query-port-boundary.svg
.run/n+1liner/final/assets/diagrams/skew-profile/skew-profile.drawio
.run/n+1liner/final/assets/diagrams/skew-profile/skew-profile.svg
.run/n+1liner/final/assets/diagrams/strategy-journey/strategy-journey.drawio
.run/n+1liner/final/assets/diagrams/strategy-journey/strategy-journey.svg
.run/n+1liner/final/assets/diagrams/target-schema/target-schema.drawio
.run/n+1liner/final/assets/diagrams/target-schema/target-schema.svg
.run/n+1liner/final/evidence/explain/crown-deep-keyset-precompute.txt
.run/n+1liner/final/evidence/explain/crown-deep-keyset-single-or.txt
.run/n+1liner/final/evidence/explain/crown-unified-precompute-plan.txt
.run/n+1liner/final/evidence/explain/highlights-child-plan-A.txt
.run/n+1liner/final/evidence/explain/l14-lateral-no-index.txt
.run/n+1liner/final/evidence/explain/l14-lateral-plan.txt
.run/n+1liner/final/evidence/explain/l14-twostep-plan.txt
.run/n+1liner/final/evidence/explain/l14-window-plan.txt
.run/n+1liner/final/evidence/explain/l15-keyset-index-seek.txt
.run/n+1liner/final/evidence/explain/l15-keyset-no-index.txt
.run/n+1liner/final/evidence/explain/l15-offset-deep-page.txt
.run/n+1liner/final/evidence/explain/l15-visibility-or-probe.txt
.run/n+1liner/final/evidence/explain/l16-precompute-plan.txt
.run/n+1liner/final/evidence/explain/l16-single-or-plan.txt
.run/n+1liner/final/evidence/explain/l16-union-branches.txt
.run/n+1liner/final/evidence/explain/l16-union-decompose-plan.txt
.run/n+1liner/final/evidence/explain/l3-cartesian-join-plan.txt
.run/n+1liner/final/evidence/explain/l4-collection-join-no-limit.txt
.run/n+1liner/final/evidence/explain/l4-entity-paging-limit.txt
.run/n+1liner/final/evidence/explain/l5-batch-in-semijoin.txt
.run/n+1liner/final/evidence/explain/l5-entity-paging-limit.txt
.run/n+1liner/final/evidence/explain/l6-child-projection.txt
.run/n+1liner/final/evidence/explain/l6-parent-projection.txt
.run/n+1liner/final/evidence/explain/toone-pages-plan.txt
.run/n+1liner/final/evidence/explain/toone-users-plan.txt
.run/n+1liner/final/evidence/metrics/crown-unified-plan.csv
.run/n+1liner/final/evidence/metrics/l1-query-growth.csv
.run/n+1liner/final/evidence/metrics/l1-skew-distribution.csv
.run/n+1liner/final/evidence/metrics/l14-group-size.csv
.run/n+1liner/final/evidence/metrics/l14-index-toggle.csv
.run/n+1liner/final/evidence/metrics/l14-plan-compare.csv
.run/n+1liner/final/evidence/metrics/l14-topn-resolution.csv
.run/n+1liner/final/evidence/metrics/l15-deep-page-compare.csv
.run/n+1liner/final/evidence/metrics/l15-depth-curve.csv
.run/n+1liner/final/evidence/metrics/l16-plan-compare.csv
.run/n+1liner/final/evidence/metrics/l2-toone-split.csv
.run/n+1liner/final/evidence/metrics/l3-cartesian.csv
.run/n+1liner/final/evidence/metrics/l4-cost-curve.csv
.run/n+1liner/final/evidence/metrics/l4-inmemory-paging.csv
.run/n+1liner/final/evidence/metrics/l5-batch-resolution.csv
.run/n+1liner/final/evidence/metrics/l5-hydration-probe.csv
.run/n+1liner/final/evidence/metrics/l6-explain-width.csv
.run/n+1liner/final/evidence/metrics/l6-projection-resolution.csv
.verify/application-core-golden-lint.json
.verify/application-core-outline.json
.verify/application-core-sources.json
.verify/coverage.txt
.verify/pip-wheel.log
config/pipeline.mock.json
config/pipeline.multi-agent.example.json
docs/ARCHITECTURE.md
@@ -11,11 +272,119 @@ docs/EXTENDING.md
docs/LOGIC_MODEL.md
docs/PROVIDERS.md
docs/SECURITY.md
docs/superpowers/plans/2026-07-29-korean-experience-prose-contract.md
docs/superpowers/specs/2026-07-29-korean-experience-prose-contract-design.md
examples/briefs/application-core-spring-di-blog.json
examples/briefs/retry-policy-blog.json
examples/corpus/llm-wiki-mini/raw/branch-notes/feature-application-port-usecase-contract.md
examples/corpus/llm-wiki-mini/raw/branch-notes/feature-log-management-contract.md
examples/corpus/llm-wiki-mini/raw/official-docs/spring-component-scanning.md
examples/corpus/llm-wiki-mini/wiki/projects/ca-tmpl/clean-architecture-package-layout.md
examples/golden/application-core-spring-di-boundary.evidence-map.json
examples/golden/application-core-spring-di-boundary.md
examples/golden/application-core-spring-di-boundary.provenance.md
examples/golden/executable-clean-architecture/assets/architecture-layered-2026-07-04.svg
examples/golden/executable-clean-architecture/assets/architecture-three-lenses.svg
examples/golden/executable-clean-architecture/assets/big-picture.svg
examples/golden/executable-clean-architecture/assets/boundary-enforcement-ladder.svg
examples/golden/executable-clean-architecture/assets/context-system-boundary.svg
examples/golden/executable-clean-architecture/assets/decision-spectrum-1.svg
examples/golden/executable-clean-architecture/assets/decision-spectrum-3.svg
examples/golden/executable-clean-architecture/assets/enforcement-ladder.svg
examples/golden/executable-clean-architecture/assets/hexagonal-ports.svg
examples/golden/executable-clean-architecture/assets/idempotency-four-branches.svg
examples/golden/executable-clean-architecture/assets/lock-timeout-routing-gap.svg
examples/golden/executable-clean-architecture/assets/logical-four-rings.svg
examples/golden/executable-clean-architecture/assets/mdc-request-lifecycle.svg
examples/golden/executable-clean-architecture/assets/module-graph-measured.svg
examples/golden/executable-clean-architecture/assets/module-vs-single.svg
examples/golden/executable-clean-architecture/assets/outbox-state-machine.svg
examples/golden/executable-clean-architecture/assets/outbox-two-paths.svg
examples/golden/executable-clean-architecture/assets/production-vs-optin.drawio
examples/golden/executable-clean-architecture/assets/production-vs-optin.svg
examples/golden/executable-clean-architecture/assets/runtime-call-source-dependency.svg
examples/golden/executable-clean-architecture/assets/runtime-seq-feed.svg
examples/golden/executable-clean-architecture/assets/static-analysis-venn.svg
examples/golden/executable-clean-architecture/assets/test-contrast.svg
examples/golden/executable-clean-architecture/assets/test-taxonomy-layers.svg
examples/golden/executable-clean-architecture/assets/three-gate-flow.svg
examples/golden/executable-clean-architecture/assets/transaction-lock-independent-contracts.svg
examples/golden/executable-clean-architecture/assets/bootstrap-dependency-guards/bootstrap-dependency-guards.svg
examples/golden/executable-clean-architecture/assets/inbound-transport-boundary/inbound-transport-boundary.svg
examples/golden/executable-clean-architecture/claridoc-rewrite/document.md
examples/golden/executable-clean-architecture/claridoc-rewrite/.techviz/production-vs-optin/spec.json
examples/golden/n+1liner/n+1liner.md
examples/golden/n+1liner/.techviz/baseline-schema/spec.json
examples/golden/n+1liner/.techviz/eager-lazy-query-sequence/spec.json
examples/golden/n+1liner/.techviz/nplus1-query-fanout/spec.json
examples/golden/n+1liner/.techviz/query-port-boundary/spec.json
examples/golden/n+1liner/.techviz/skew-profile/spec.json
examples/golden/n+1liner/.techviz/strategy-journey/spec.json
examples/golden/n+1liner/.techviz/target-schema/spec.json
examples/golden/n+1liner/assets/README.md
examples/golden/n+1liner/assets/diagrams/baseline-schema/baseline-schema.drawio
examples/golden/n+1liner/assets/diagrams/baseline-schema/baseline-schema.svg
examples/golden/n+1liner/assets/diagrams/eager-lazy-query-sequence/eager-lazy-query-sequence.drawio
examples/golden/n+1liner/assets/diagrams/eager-lazy-query-sequence/eager-lazy-query-sequence.svg
examples/golden/n+1liner/assets/diagrams/nplus1-query-fanout/nplus1-query-fanout.drawio
examples/golden/n+1liner/assets/diagrams/nplus1-query-fanout/nplus1-query-fanout.svg
examples/golden/n+1liner/assets/diagrams/query-port-boundary/query-port-boundary.drawio
examples/golden/n+1liner/assets/diagrams/query-port-boundary/query-port-boundary.svg
examples/golden/n+1liner/assets/diagrams/skew-profile/skew-profile.drawio
examples/golden/n+1liner/assets/diagrams/skew-profile/skew-profile.svg
examples/golden/n+1liner/assets/diagrams/strategy-journey/strategy-journey.drawio
examples/golden/n+1liner/assets/diagrams/strategy-journey/strategy-journey.svg
examples/golden/n+1liner/assets/diagrams/target-schema/target-schema.drawio
examples/golden/n+1liner/assets/diagrams/target-schema/target-schema.svg
examples/golden/n+1liner/evidence/explain/crown-deep-keyset-precompute.txt
examples/golden/n+1liner/evidence/explain/crown-deep-keyset-single-or.txt
examples/golden/n+1liner/evidence/explain/crown-unified-precompute-plan.txt
examples/golden/n+1liner/evidence/explain/highlights-child-plan-A.txt
examples/golden/n+1liner/evidence/explain/l14-lateral-no-index.txt
examples/golden/n+1liner/evidence/explain/l14-lateral-plan.txt
examples/golden/n+1liner/evidence/explain/l14-twostep-plan.txt
examples/golden/n+1liner/evidence/explain/l14-window-plan.txt
examples/golden/n+1liner/evidence/explain/l15-keyset-index-seek.txt
examples/golden/n+1liner/evidence/explain/l15-keyset-no-index.txt
examples/golden/n+1liner/evidence/explain/l15-offset-deep-page.txt
examples/golden/n+1liner/evidence/explain/l15-visibility-or-probe.txt
examples/golden/n+1liner/evidence/explain/l16-precompute-plan.txt
examples/golden/n+1liner/evidence/explain/l16-single-or-plan.txt
examples/golden/n+1liner/evidence/explain/l16-union-branches.txt
examples/golden/n+1liner/evidence/explain/l16-union-decompose-plan.txt
examples/golden/n+1liner/evidence/explain/l3-cartesian-join-plan.txt
examples/golden/n+1liner/evidence/explain/l4-collection-join-no-limit.txt
examples/golden/n+1liner/evidence/explain/l4-entity-paging-limit.txt
examples/golden/n+1liner/evidence/explain/l5-batch-in-semijoin.txt
examples/golden/n+1liner/evidence/explain/l5-entity-paging-limit.txt
examples/golden/n+1liner/evidence/explain/l6-child-projection.txt
examples/golden/n+1liner/evidence/explain/l6-parent-projection.txt
examples/golden/n+1liner/evidence/explain/toone-pages-plan.txt
examples/golden/n+1liner/evidence/explain/toone-users-plan.txt
examples/golden/n+1liner/evidence/metrics/crown-unified-plan.csv
examples/golden/n+1liner/evidence/metrics/l1-query-growth.csv
examples/golden/n+1liner/evidence/metrics/l1-skew-distribution.csv
examples/golden/n+1liner/evidence/metrics/l14-group-size.csv
examples/golden/n+1liner/evidence/metrics/l14-index-toggle.csv
examples/golden/n+1liner/evidence/metrics/l14-plan-compare.csv
examples/golden/n+1liner/evidence/metrics/l14-topn-resolution.csv
examples/golden/n+1liner/evidence/metrics/l15-deep-page-compare.csv
examples/golden/n+1liner/evidence/metrics/l15-depth-curve.csv
examples/golden/n+1liner/evidence/metrics/l16-plan-compare.csv
examples/golden/n+1liner/evidence/metrics/l2-toone-split.csv
examples/golden/n+1liner/evidence/metrics/l3-cartesian.csv
examples/golden/n+1liner/evidence/metrics/l4-cost-curve.csv
examples/golden/n+1liner/evidence/metrics/l4-inmemory-paging.csv
examples/golden/n+1liner/evidence/metrics/l5-batch-resolution.csv
examples/golden/n+1liner/evidence/metrics/l5-hydration-probe.csv
examples/golden/n+1liner/evidence/metrics/l6-explain-width.csv
examples/golden/n+1liner/evidence/metrics/l6-projection-resolution.csv
examples/output/retry-policy-demo/manifest.json
examples/output/retry-policy-demo/provider-events.jsonl
examples/output/retry-policy-demo/run.json
examples/output/retry-policy-demo/final/document.md
examples/output/retry-policy-demo/final/evidence-map.json
examples/output/retry-policy-demo/final/provenance.md
examples/output/retry-policy-demo/final/quality-report.md
examples/output/retry-policy-demo/inputs/brief.normalized.json
examples/output/retry-policy-demo/inputs/pipeline.normalized.json
@@ -26,6 +395,16 @@ examples/output/retry-policy-demo/rounds/round-01/lint.md
examples/output/retry-policy-demo/rounds/round-01/quality-gate.json
examples/output/retry-policy-demo/rounds/round-01/review-01-logic.json
examples/output/retry-policy-demo/rounds/round-01/review-01-logic.raw.txt
examples/output/retry-policy-demo/rounds/round-01/review-02-decision.json
examples/output/retry-policy-demo/rounds/round-01/review-02-decision.raw.txt
examples/output/retry-policy-demo/rounds/round-01/review-03-reader.json
examples/output/retry-policy-demo/rounds/round-01/review-03-reader.raw.txt
examples/output/retry-policy-demo/rounds/round-01/review-04-editor.json
examples/output/retry-policy-demo/rounds/round-01/review-04-editor.raw.txt
examples/output/retry-policy-demo/rounds/round-01/review-05-evidence.json
examples/output/retry-policy-demo/rounds/round-01/review-05-evidence.raw.txt
examples/output/retry-policy-demo/rounds/round-01/review-06-operations.json
examples/output/retry-policy-demo/rounds/round-01/review-06-operations.raw.txt
examples/output/retry-policy-demo/stages/01-planner.raw.txt
examples/output/retry-policy-demo/stages/02-outline.json
examples/output/retry-policy-demo/stages/02-outline.md
@@ -40,6 +419,7 @@ schemas/review.schema.json
schemas/source-pack.schema.json
scripts/run-demo.ps1
scripts/run-demo.sh
scripts/run-local-corpus-example.sh
scripts/test.sh
scripts/verify.sh
src/claridoc/__init__.py
@@ -58,10 +438,12 @@ src/claridoc/utils.py
src/claridoc/__pycache__/__init__.cpython-312.pyc
src/claridoc/__pycache__/__main__.cpython-312.pyc
src/claridoc/__pycache__/cli.cpython-312.pyc
src/claridoc/__pycache__/corpus.cpython-312.pyc
src/claridoc/__pycache__/lint.cpython-312.pyc
src/claridoc/__pycache__/models.cpython-312.pyc
src/claridoc/__pycache__/pipeline.cpython-312.pyc
src/claridoc/__pycache__/prompts.cpython-312.pyc
src/claridoc/__pycache__/provenance.cpython-312.pyc
src/claridoc/__pycache__/report.cpython-312.pyc
src/claridoc/__pycache__/structures.cpython-312.pyc
src/claridoc/__pycache__/templates.cpython-312.pyc
@@ -97,4 +479,15 @@ tests/test_prompts.py
tests/test_providers.py
tests/test_schemas.py
tests/test_structures.py
tests/__pycache__/__init__.cpython-312.pyc
tests/__pycache__/helpers.cpython-312.pyc
tests/__pycache__/test_cli.cpython-312.pyc
tests/__pycache__/test_corpus.cpython-312.pyc
tests/__pycache__/test_lint.cpython-312.pyc
tests/__pycache__/test_models.cpython-312.pyc
tests/__pycache__/test_pipeline.cpython-312.pyc
tests/__pycache__/test_prompts.cpython-312.pyc
tests/__pycache__/test_providers.cpython-312.pyc
tests/__pycache__/test_schemas.cpython-312.pyc
tests/__pycache__/test_structures.cpython-312.pyc
verification/TEST_REPORT.md
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
+159
View File
@@ -13,6 +13,50 @@ from tests.helpers import brief_dict, make_brief, make_sources
class LintTests(unittest.TestCase):
@staticmethod
def _korean_experience_brief(document_type: str = "technical_blog") -> Brief:
data = brief_dict(document_type)
data["title"] = "기술적 선택을 설명하는 글"
data["language"] = "ko-KR"
data["reader_goal"] = "안전한 구현 방식을 선택합니다"
data["core_message"] = "기술 선택은 문제와 비용을 함께 설명해야 합니다."
data["constraints"]["style_profile"] = "auto"
return Brief.from_dict(data)
@staticmethod
def _experience_document(
brief: Brief,
*,
marked_sections: set[int] | None = None,
body_by_section: dict[int, str] | None = None,
extra_by_section: dict[int, str] | None = None,
) -> tuple[str, object]:
sources = make_sources()
outline = create_outline(brief, sources)
marked_sections = (
set(range(len(outline.sections)))
if marked_sections is None
else marked_sections
)
body_by_section = body_by_section or {}
extra_by_section = extra_by_section or {}
lines = [f"# {brief.title}", ""]
for index, section in enumerate(outline.sections):
lines.extend([f"## {section.title}", ""])
if index in body_by_section:
lines.append(body_by_section[index])
else:
subject = "저는 " if index in marked_sections else ""
lines.append(
f"{subject}이 절의 입력과 실제 동작을 확인했습니다. "
"현재 구현은 명시된 경계를 사용합니다. "
"대안과 비용, 검증 범위도 함께 설명합니다."
)
if index in extra_by_section:
lines.extend(["", extra_by_section[index]])
lines.append("")
return "\n".join(lines), outline
def test_mock_document_meets_structural_gate(self) -> None:
brief = make_brief()
sources = make_sources()
@@ -142,6 +186,121 @@ class LintTests(unittest.TestCase):
self.assertIn("STYLE001", {issue.code for issue in report.issues})
self.assertEqual(report.metrics["formulaic_ordinal_opening_count"], 3)
def test_korean_experience_contract_blocks_plain_form_endings(self) -> None:
brief = self._korean_experience_brief()
sources = make_sources()
text, outline = self._experience_document(
brief,
extra_by_section={0: "현재 구현은 이 값을 사용한다."},
)
report = lint_document(text, brief, outline, sources)
issues = [issue for issue in report.issues if issue.code == "STYLE002"]
self.assertEqual(len(issues), 1)
self.assertEqual(issues[0].severity, Severity.BLOCKER)
self.assertEqual(report.metrics["plain_form_ending_count"], 1)
def test_korean_style_lint_exempts_non_reader_prose(self) -> None:
brief = self._korean_experience_brief()
sources = make_sources()
text, outline = self._experience_document(
brief,
extra_by_section={
0: (
"### 현재 구현은 사용한다.\n\n"
"> 원문 인용은 현재 구현을 사용한다.\n\n"
"항목 | 설명\n"
"--- | ---\n"
"현재 값 | 현재 구현은 사용한다.\n\n"
"![현재 구현은 사용한다.](diagram.svg)\n\n"
" 명령 출력은 현재 구현을 사용한다.\n\n"
"`현재 구현은 사용한다.`\n\n"
"직접 기록에는 “현재 구현은 사용한다.”라고 적혀 있습니다.\n\n"
"```text\n"
"현재 구현은 사용한다.\n"
"```"
)
},
)
report = lint_document(text, brief, outline, sources)
self.assertNotIn("STYLE002", {issue.code for issue in report.issues})
self.assertEqual(report.metrics["plain_form_ending_count"], 0)
def test_korean_style_lint_requires_first_person_opening(self) -> None:
brief = self._korean_experience_brief()
sources = make_sources()
text, outline = self._experience_document(
brief,
marked_sections=set(range(1, 8)),
)
report = lint_document(text, brief, outline, sources)
issues = [issue for issue in report.issues if issue.code == "STYLE003"]
self.assertEqual(len(issues), 1)
self.assertEqual(issues[0].severity, Severity.BLOCKER)
self.assertFalse(report.metrics["opening_has_first_person"])
def test_korean_style_lint_requires_major_section_coverage(self) -> None:
brief = self._korean_experience_brief()
sources = make_sources()
text, outline = self._experience_document(
brief,
marked_sections={0},
)
report = lint_document(text, brief, outline, sources)
self.assertIn("STYLE003", {issue.code for issue in report.issues})
self.assertEqual(report.metrics["experience_section_count"], 8)
self.assertEqual(report.metrics["marked_experience_section_count"], 1)
self.assertEqual(report.metrics["experience_section_coverage"], 0.125)
def test_korean_style_lint_ignores_non_prose_sections(self) -> None:
brief = self._korean_experience_brief()
sources = make_sources()
text, outline = self._experience_document(
brief,
marked_sections={0, 1},
body_by_section={
4: "```text\n현재 구현은 사용한다.\n```",
5: "항목 | 값\n--- | ---\n구현 | 현재 값",
6: "![구조 그림](diagram.svg)",
7: "> 원문 인용만 남아 있습니다.",
},
)
report = lint_document(text, brief, outline, sources)
self.assertNotIn("STYLE003", {issue.code for issue in report.issues})
self.assertEqual(report.metrics["experience_section_count"], 4)
self.assertEqual(report.metrics["marked_experience_section_count"], 2)
self.assertEqual(report.metrics["experience_section_coverage"], 0.5)
def test_korean_style_lint_accepts_compliant_experience_prose(self) -> None:
brief = self._korean_experience_brief("readme")
sources = make_sources()
text, outline = self._experience_document(
brief,
marked_sections={0, 2, 4, 6},
)
report = lint_document(text, brief, outline, sources)
codes = {issue.code for issue in report.issues}
self.assertNotIn("STYLE002", codes)
self.assertNotIn("STYLE003", codes)
self.assertEqual(
report.metrics["style_contract"],
"korean_first_person_experience_v1",
)
self.assertTrue(report.metrics["opening_has_first_person"])
self.assertEqual(report.metrics["first_person_marker_count"], 4)
self.assertEqual(report.metrics["experience_section_coverage"], 0.5)
def test_numbered_procedure_is_not_formulaic_ordinal_prose(self) -> None:
data = brief_dict()
data["title"] = "기술적 선택을 설명하는 글"