기술 문서를 에이전트 팀이 협업하여 전문적으로 작성하는 파이프라인. '기술 문서 작성해줘', 'API 문서', '아키텍처 문서', '사용자 가이드', '개발자 문서', 'README 작성', '튜토리얼 만들어줘', '운영 매뉴얼', '기술 블로그', '문서화', 'documentation', '기술 명세서' 등 기술 문서 작성 전반에 이 스킬을 사용한다. 기존 코드나 기존 문서가 있는 경우에도 리뷰와 개선을 지원한다. 단, 소스 코드 작성, 테스트 실행, CI/CD 구축, 실제 문서 호스팅 배포는 이 스킬의 범위가 아니다.
구조설계→집필→다이어그램→리뷰→버전관리를 에이전트 팀이 협업하여 한 번에 생성한다.
에이전트 팀 — 5명이 SendMessage로 직접 통신하며 교차 검증한다.
| 에이전트 | 파일 | 역할 | 타입 |
|---|---|---|---|
| info-architect | .claude/agents/info-architect.md | 구조 설계, 독자 분석, 목차 | general-purpose |
| doc-writer | .claude/agents/doc-writer.md | 본문 작성, 코드 예제, 튜토리얼 | general-purpose |
| diagram-maker | .claude/agents/diagram-maker.md | Mermaid 다이어그램, 시각 자료 | general-purpose |
| tech-reviewer | .claude/agents/tech-reviewer.md | 정확성, 완전성, 일관성 검증 | general-purpose |
| version-controller |
.claude/agents/version-controller.md |
| 메타데이터, 변경 이력, 배포 |
| general-purpose |
_workspace/ 디렉토리를 프로젝트 루트에 생성한다_workspace/00_input.md에 저장한다_workspace/에 복사하고 해당 Phase를 건너뛴다| 순서 | 작업 | 담당 | 의존 | 산출물 |
|---|---|---|---|---|
| 1 | 구조 설계 | architect | 없음 | _workspace/01_doc_structure.md |
| 2a | 본문 집필 | writer | 작업 1 | _workspace/02_doc_draft.md |
| 2b | 다이어그램 작성 | diagram | 작업 1 | _workspace/03_diagrams.md |
| 3 | 기술 리뷰 | reviewer | 작업 2a, 2b | _workspace/04_review_report.md |
| 4 | 버전 관리 | version | 작업 1~3 | _workspace/05_version_meta.md |
작업 2a(본문)와 2b(다이어그램)는 병렬 실행한다. 둘 다 작업 1(구조)에만 의존하므로 동시에 시작할 수 있다.
팀원 간 소통 흐름:
_workspace/ 내 모든 파일을 확인한다01_doc_structure.md02_doc_draft.md03_diagrams.md04_review_report.md05_version_meta.md| 사용자 요청 패턴 | 실행 모드 | 투입 에이전트 |
|---|---|---|
| "기술 문서 전체 작성" | 풀 파이프라인 | 5명 전원 |
| "문서 구조만 잡아줘" | 설계 모드 | architect + reviewer |
| "이 내용으로 문서 써줘" (구조 있음) | 집필 모드 | writer + diagram + reviewer |
| "이 문서에 다이어그램 추가" | 다이어그램 모드 | diagram + reviewer |
| "이 문서 리뷰해줘" | 리뷰 모드 | reviewer 단독 |
| "이 문서 업데이트해줘" (기존 버전) | 업데이트 모드 | writer + reviewer + version |
기존 파일 활용: 기존 문서, 코드, 스펙을 제공하면 해당 단계를 건너뛰거나 기존 자료 기반으로 작업한다.
| 전략 | 방식 | 용도 |
|---|---|---|
| 파일 기반 | _workspace/ 디렉토리 | 주요 산출물 저장 및 공유 |
| 메시지 기반 | SendMessage | 실시간 핵심 정보 전달, 수정 요청 |
| 태스크 기반 | TaskCreate/TaskUpdate | 진행 상황 추적, 의존 관계 관리 |
파일명 컨벤션: {순번}_{에이전트}_{산출물}.{확장자}
| 에러 유형 | 전략 |
|---|---|
| 문서 주제/범위 불명확 | 독자·목적 후보 제시, 선택 유도 |
| 기술 세부사항 부족 | [확인 필요] 태그 삽입, 리뷰 시 검증 |
| 코드 예제 검증 불가 | "검증 필요" 표시, 독자에게 테스트 권고 |
| 에이전트 실패 | 1회 재시도 → 실패 시 해당 산출물 없이 진행, 리뷰 보고서에 누락 명시 |
| 리뷰에서 🔴 발견 | 해당 에이전트에 수정 요청 → 재작업 → 재검증 (최대 2회) |
프롬프트: "우리 팀의 결제 API를 문서화해줘. 대상은 외부 개발자이고, REST API 5개 엔드포인트가 있어." 기대 결과:
프롬프트: "이 문서 구조는 잡혀 있는데, 본문을 작성해줘" + 구조 파일 첨부 기대 결과:
프롬프트: "기술 문서 써줘, 주제는 대충 우리 시스템 전반" 기대 결과:
각 에이전트의 전문성을 강화하는 도메인 특화 스킬:
| 확장 스킬 | 경로 | 대상 에이전트 | 역할 |
|---|---|---|---|
| diagram-patterns | .claude/skills/diagram-patterns/skill.md | diagram-maker | Mermaid 다이어그램 패턴 라이브러리 (아키텍처, 시퀀스, 플로차트, ER, 상태 다이어그램) |
| api-doc-standards | .claude/skills/api-doc-standards/skill.md | doc-writer | REST API 문서 작성 표준 (엔드포인트 템플릿, 에러 코드, 페이지네이션, 인증) |
| code-example-patterns | .claude/skills/code-example-patterns/skill.md | doc-writer | 코드 예제 패턴 (5단계 구조, 언어별 스타일, 튜토리얼 구성) |