brief.json + sources.json
          │
          ▼
[문서 유형별 구조 계약]
          │  planner: Codex
          ▼
[질문 기반 outline.json]
          │  writer: Claude
          ▼
[draft.md]
          │
          ├── 결정적 린터
          ├── 논리 리뷰: Codex
          ├── 독자 리뷰: Claude
          ├── 근거 리뷰: Antigravity
          └── 운영 리뷰: Antigravity
          │
          ▼
[품질 게이트] ── 실패 ──> reviser: Claude ──> 재검사
          │ 통과 또는 수정 한도 도달
          ▼
final/document.md + quality-report.md + manifest.json

모델이 자유롭게 목차부터 만들게 두지 않는다. 먼저 코드가 문서 유형별 필수 질문과 순서를 정하고, planner는 제목·전환·근거 배치를 정교화하되 필수 intent를 삭제하거나 재배열할 수 없다. 모델 출력이 구조 계약을 위반하면 planner 단계는 결정적 기본 구조로 폴백한다.

지원 문서 유형

`document_type`	독자 요구	기본 논리 축
`technical_blog`	문제와 설계 판단을 이해	결론 → 맥락/제약 → 멘털 모델 → 메커니즘 → 예시 → 검증 → 트레이드오프 → 행동
`tutorial`	안내를 따라 학습·완성	결과 → 준비 → 전체 경로 → 단계 → 체크포인트 → 최종 검증 → 다음 학습
`how_to`	특정 작업을 안전하게 완료	목표/적용 조건 → 사전 조건 → 절차 → 확인 → 롤백 → 문제 해결
`explanation`	개념과 원리를 이해	질문/답 → 익숙한 기준점 → 모델 → 인과 과정 → 예시 → 대안 → 한계 → 실무 의미
`reference`	정확한 사실을 빠르게 조회	범위/버전 → 구문 → 필드 → 동작 → 오류 → 최소 예시 → 관련 항목
`troubleshooting`	증상에서 원인과 복구로 이동	증상 → 영향 → 안전 → 최소 진단 → 원인 분기 → 조치 → 복구 확인 → 예방
`design_doc`	대안을 비교하고 결정을 승인	결정 요청 → 문제 → 목표/비목표 → 제약 → 대안 → 선택 → 아키텍처 → 실패 → 롤아웃 → 관측 → 위험

상세 근거는 research/FOUNDATIONS.md, 구현 규칙은 docs/LOGIC_MODEL.md에 정리되어 있다.

빠른 실행: 외부 모델 없이 전체 흐름 검증

요구 사항은 Python 3.10 이상이다. 핵심 패키지는 외부 Python 의존성이 없다.

cd claridoc-harness
python3 -m venv .venv
. .venv/bin/activate
python -m pip install -e .

claridoc run \
  --brief examples/briefs/retry-policy-blog.json \
  --sources examples/sources/retry-policy-sources.json \
  --config config/pipeline.mock.json \
  --output .run/retry-policy

또는 저장소에서 바로 실행한다.

bash scripts/run-demo.sh

Mock 제공자는 파이프라인·계약·린터·보고서 재현용이다. 언어 모델 품질을 증명하지 않으며, 생성 점수도 외부 모델 평가값이 아니라 테스트용 결정적 값이다.

Codex + Claude + Antigravity 실행

예제 역할 배치는 다음과 같다.

Codex: 구조 planner와 논리 reviewer
Claude: primary writer, reader reviewer, reviser
Antigravity: evidence reviewer와 operations reviewer

먼저 각 도구를 설치하고 인증한 뒤 진단한다.

claridoc doctor --config config/pipeline.multi-agent.example.json

Antigravity SDK 어댑터를 사용할 때는 선택 의존성을 설치한다.

python -m pip install -e '.[antigravity]'

실행:

claridoc run \
  --brief examples/briefs/retry-policy-blog.json \
  --sources examples/sources/retry-policy-sources.json \
  --config config/pipeline.multi-agent.example.json \
  --output .run/retry-policy-live

기본 호출 방식은 다음과 같다.

제공자	기본 통합	안전 기본값
Codex	`codex exec`에 프롬프트를 stdin으로 전달하고 마지막 메시지를 파일로 수집	`--sandbox read-only`, Git 저장소 검사 생략 가능
Claude	`claude -p --output-format text`와 piped task	파일 변경을 요구하지 않는 출력 전용 프롬프트
Antigravity	`google.antigravity.Agent` + `LocalAgentConfig`	SDK 설정을 명시적으로 전달; 하네스 자체는 도구 실행을 요청하지 않음

조직별 래퍼가 있으면 provider의 options.command 또는 options.extra_args를 사용한다. 자세한 내용은 docs/PROVIDERS.md를 참조한다.

입력 계약

`brief.json`

브리프는 문서 주제보다 독자가 왜 읽는지를 더 엄격하게 정의한다.

{
  "title": "API 재시도는 횟수가 아니라 부하 예산으로 설계한다",
  "document_type": "technical_blog",
  "language": "ko-KR",
  "audience": {
    "roles": ["백엔드 개발자"],
    "prior_knowledge": ["HTTP와 타임아웃의 기본 개념"],
    "needs": ["재시도 정책의 판단 기준"]
  },
  "reader_goal": "장애를 증폭하지 않는 재시도 정책을 설계한다",
  "core_message": "재시도는 실패 중인 의존성에 보내는 추가 부하 예산이다.",
  "scope": ["동기 HTTP 클라이언트 재시도"],
  "non_scope": ["메시지 큐 전달 보장 전체"],
  "prerequisites": ["로그와 지표를 조회할 수 있음"],
  "required_topics": ["멱등성", "백오프", "지터", "한도", "검증"],
  "constraints": {
    "target_words": 1200,
    "tone": "직접적이고 검증 가능한 문체",
    "version_context": "HTTP 의미론은 RFC 9110, 2026-07-23 기준",
    "max_heading_depth": 3,
    "require_citations": true,
    "allow_external_knowledge": false
  },
  "forbidden_claims": ["재시도는 항상 안전하다"],
  "metadata": {"risk": "high"}
}

allow_external_knowledge: false일 때 모델은 근거 팩 밖의 외부 사실을 추가하지 않도록 지시받는다. 논리 설명과 명시적인 가상 예시는 가능하지만 측정값·버전·사건·API를 지어낼 수 없다.

`sources.json`

근거 팩은 URL 목록이 아니라 출처가 실제로 지지하는 사실의 최소 단위를 제공한다.

{
  "sources": [
    {
      "id": "S1",
      "title": "Authoritative source title",
      "url": "https://example.com/source",
      "publisher": "Publisher",
      "accessed": "2026-07-23",
      "facts": ["This source explicitly supports this fact."],
      "notes": "Allowed use and limitations"
    }
  ]
}

모델은 문서에서 [S1]처럼 인용한다. 린터는 존재하지 않는 ID, 근거 팩이 비었는데 인용이 필수인 경우, 출처가 있는데 하나도 사용하지 않은 경우를 검사한다. 하네스는 URL 내용을 자동으로 신뢰하거나 실행하지 않는다.

스키마는 schemas/에 있다.

명시적인 pipeline JSON은 planner, writer, reviewers, reviser를 모두 포함해야 하며 reviewer는 최소 한 명이어야 한다. reviewer role은 중복될 수 없고, 모델 리뷰는 9개 고정 평가 차원과 허용된 severity만 반환해야 한다. 일부 역할에 Mock을 섞으면 합성 점수가 실제 모델 평가처럼 보이지 않도록 실행 경고가 자동으로 남는다.

명령어

claridoc init [directory] [--force]
claridoc validate --brief BRIEF [--sources SOURCES]
claridoc outline --brief BRIEF [--sources SOURCES] [--output OUTLINE]
claridoc lint DOCUMENT --brief BRIEF [--sources SOURCES] [--json] [--output REPORT]
claridoc run --brief BRIEF [--sources SOURCES] [--config PIPELINE] --output RUN_DIR
claridoc doctor --config PIPELINE [--json]

claridoc init은 시작용 브리프, 근거 팩, Mock 설정을 만든다.

품질 게이트

기본 복합 점수는 다음과 같다.

composite = deterministic_lint × 0.4 + model_review_mean × 0.6

점수만으로 통과시키지 않는다. 다음을 동시에 확인한다.

최소 복합 점수
blocker 최대 개수
error 최대 개수
최대 수정 라운드

결정적 린터의 주요 검사:

H1 개수와 제목, heading level skip, 중복·일반적 제목
문서 유형 계약의 필수 H2 존재와 순서
오프닝의 독자 목표·핵심 메시지·비범위 노출
과도하게 긴 문단과 문장, 한 문단에 과도한 문장 수
절차 문서의 번호 단계·사전 조건·검증·롤백
기술 블로그/설명의 예시와 트레이드오프
닫히지 않은 코드 fence와 언어 태그
출처 ID, 인용 부재, 숫자·버전형 주장에 대한 근거 표식
TODO/TBD/FIXME, 금지 주장
파괴적 명령 주변의 경고·백업·복구 경로
버전/날짜 맥락과 목표 길이

린터는 휴리스틱이다. 문장의 참·거짓과 실제 코드 동작을 보증하지 않는다. 이 부분은 출처 검증, 코드 테스트, 도메인 소유자 리뷰로 보완해야 한다.

산출물

run-dir/
├── inputs/
│   ├── brief.normalized.json
│   ├── sources.normalized.json
│   └── pipeline.normalized.json
├── stages/
│   ├── 01-planner.raw.txt
│   ├── 02-outline.json
│   ├── 02-outline.md
│   └── 03-writer.raw.txt
├── rounds/
│   └── round-01/
│       ├── draft.md
│       ├── lint.json
│       ├── lint.md
│       ├── review-*.json
│       ├── review-*.raw.txt
│       └── quality-gate.json
├── final/
│   ├── document.md
│   └── quality-report.md
├── provider-events.jsonl
├── run.json
└── manifest.json

manifest.json은 자신을 제외한 산출물의 바이트 크기와 SHA-256을 기록한다. 모델 프롬프트에는 소스·브리프가 신뢰되지 않은 데이터라는 경계를 반복해서 넣으며, 원문 응답을 보존해 사후 감사를 가능하게 한다.

테스트와 재현 검증

bash scripts/test.sh

전체 배포 전 검증은 다음 한 명령으로 수행한다.

bash scripts/verify.sh

이 명령은 단위·통합 테스트, Python 3.10 문법 호환 파싱, JSON 구문, 로컬 Markdown 링크, 입력 계약, Mock 종단 간 실행, 합성 점수 경고, 산출물 SHA-256 매니페스트를 검사한다.

테스트 범위에는 계약 파싱, 7개 문서 유형 구조, 구조 병합 실패 조건, 리뷰 스키마 우회 차단, 필수 H2 중복, 임의 source ID, 파괴적 명령 안전 통제, reviewer artifact 경로 격리, Codex/Claude 가짜 실행 파일, Antigravity 가짜 SDK, 수정 한도, 전체 Mock 파이프라인, CLI 초기화가 포함된다. 실행 시점의 상세 결과와 실제 외부 provider 미검증 범위는 verification/TEST_REPORT.md에 기록한다.

Agent Skills

저장소에는 동일한 작성 규칙을 에이전트가 직접 발견할 수 있도록 스킬을 포함한다.

Codex / Antigravity: .agents/skills/technical-document-author/SKILL.md
Claude Code: .claude/skills/technical-document-author/SKILL.md
저장소 전역 규칙: AGENTS.md, CLAUDE.md

스킬은 하네스를 우회해 자유 형식으로 글을 쓰지 않고, 브리프 → 근거 팩 → outline 계약 → 작성 → lint/review → gate 순서를 따르도록 지시한다.

보안과 한계

제공자 인증 토큰을 구성 파일에 저장하지 않는다. 각 CLI/SDK의 인증 메커니즘을 사용한다.
options.command는 신뢰된 로컬 설정으로 취급한다. 외부 입력을 그대로 command에 넣지 않는다.
Codex 기본 sandbox는 read-only다. 하네스 자체는 모델에게 shell 실행이나 파일 수정을 요구하지 않는다.
브리프·근거 팩·초안 내부의 지시문은 데이터로 취급하도록 모든 단계에서 명시한다. 다만 LLM prompt injection을 수학적으로 제거할 수는 없다.
URL 접근, 사실 수집, 링크 상태 확인은 이 버전의 core pipeline에 포함하지 않는다. 입력 근거 팩의 진실성은 작성자가 책임진다.
실제 코드 예시, 명령, API, 보안·법률·의료·재무 내용은 해당 분야 검증을 별도로 거쳐야 한다.
Mock PASS는 배선과 규칙이 동작했다는 의미이며 외부 모델이 좋은 문서를 작성했다는 증거가 아니다.

자세한 위협 모델은 docs/SECURITY.md를 참조한다.

README.md Unescape Escape

ClariDoc Harness

핵심 설계