doc-coauthoring

# Document Co-authoring > AI 기반 문서 작성 및 협업 문서의 작성, 리뷰, 업데이트를 자동화하여 일관성 있는 고품질 문서를 유지합니다. --- ## 사용법 ### 신규 문서 작성 ``` /doc-coauthoring "API 문서 작성" docs/api/README.md /doc-coauthoring "사용자 가이드" docs/user-guide.md ``` ### 기존 문서 업데이트 ``` /doc-coauthoring "업데이트" docs/architecture/design.md /doc-coauthoring "리뷰 및 개선" README.md ``` --- ## 문서 유형별 워크플로우 ### 1. API 문서 **구조:** - 개요 (Overview) - 인증 (Authentication) - 엔드포인트 (Endpoints) - 요청/응답 예시 - 에러 코드 - 사용 예시 (Examples) **생성 프로세스:** 1. 코드에서 API 정의 추출 (Glob + Read) 2. OpenAPI/Swagger 스펙 읽기 (있으면) 3. 표준 템플릿 적용 4. 예시 코드 생성 ### 2. 아키텍처 문서 **구조:** - 시스템 개요 - 구성 요소 (Components) - 데이터 플로우 - 기술 스택 - 의사결정 기록 (ADR) **생성 프로세스:** 1. 프로젝트 구조 분석 (Glob) 2. 주요 파일 읽기 (Read) 3. 다이어그램 생성 (Mermaid) 4. 의사결정 맥락 추가 ### 3. 사용자 가이드 **구조:** - 시작하기 (Getting Started) - 주요 기능 (Features) - 튜토리얼 (Tutorials) - FAQ - 트러블슈팅 (Troubleshooting) **생성 프로세스:** 1. 사용자 여정 파악 2. 스크린샷 위치 표시 3. 단계별 가이드 작성 4. 일반적인 문제 정리 ### 4. README **구조:** - 프로젝트 설명 - 기능 (Features) - 설치 (Installation) - 사용법 (Usage) - 기여 가이드 (Contributing) - 라이센스 (License) **생성 프로세스:** 1. 프로젝트 메타데이터 추출 2. 주요 기능 식별 3. 설치 단계 자동 감지 4. 배지 (Badges) 추가 --- ## 문서 품질 체크 ### 자동 검증 - [ ] **구조**: 표준 헤딩 구조 (H1 → H2 → H3) - [ ] **링크**: 깨진 링크 없음 - [ ] **코드 블록**: 언어 지정 (`python, `bash) - [ ] **일관성**: 용어 통일 (API vs api, Node.js vs nodejs) - [ ] **완전성**: 필수 섹션 포함 ### 스타일 가이드 ```markdown # 제목은 문장형 (Sentence case) ## 부제목도 문장형 - 리스트는 일관된 형식 - 들여쓰기 유지 - 마침표 규칙 통일 **굵게**: 중요 용어 `코드`: 명령어, ...