Document

문서화 스킬

사용자가 문서 작성을 요청할 때, 요청 내용을 분석하여 적절한 템플릿을 선택하고 체계적인 문서를 생성합니다.

---

1. 문서 유형 감지

사용자 요청에서 키워드를 분석하여 문서 유형을 자동으로 결정합니다.

감지 우선순위

우선순위	문서 유형	감지 키워드
1	프로젝트 계획서	계획, 기획, 설계, 로드맵, 프로젝트, 개발 계획, 구현 계획, 마일스톤
2	연구 보고서	연구, 조사, 분석, 리서치, 비교, 검토, 탐색, 평가, 시장 조사

감지 규칙

1. 키워드 매칭: 요청에서 감지 키워드 포함 여부 확인
2. 우선순위 적용: 여러 유형에 해당하면 우선순위가 높은 유형 선택
3. 모호한 경우: 판단이 어려우면 사용자에게 문서 유형 질문

예시:
- "프로젝트 계획서 작성해줘" → 프로젝트 계획서 (키워드: 계획)
- "기술 조사 보고서 만들어줘" → 연구 보고서 (키워드: 조사)
- "시스템 설계하고 분석해줘" → 프로젝트 계획서 (우선순위 1 > 2)

---

2. 템플릿 선택 가이드

사용 가능한 템플릿

문서 유형	템플릿 경로	주요 용도
프로젝트 계획서	planner-template	소프트웨어 개발, 신규 프로젝트, 기능 개발 계획
연구 보고서	research-template	기술 조사, 시장 분석, 비교 평가, 문제 해결 연구

템플릿 확장

새로운 템플릿 추가 시:

1. template/{name}-template.md 파일 생성
2. 이 문서의 감지 우선순위 테이블에 추가
3. 템플릿별 가이드 섹션 추가

---

3. 작성 워크플로우

단계별 프로세스

1. 요청 분석
   ↓
2. 문서 유형 결정 (자동 감지 또는 사용자 선택)
   ↓
3. 해당 템플릿 로드
   ↓
4. 필수 정보 수집 (필요시 사용자에게 질문)
   ↓
5. 템플릿 구조에 따라 문서 작성
   ↓
6. {{PLACEHOLDER}} 변수를 실제 내용으로 대체
   ↓
7. 에이전트 가이드 주석(<!-- Agent: ... -->) 제거
   ↓
8. 최종 검토 및 출력

정보 수집 가이드

문서 작성 전 다음 정보를 확인/수집합니다:

프로젝트 계획서

• 프로젝트명, 프로젝트 유형
• 목적 및 범위
• 기술 스택 (선호하는 기술이 있는 경우)
• 주요 기능 요구사항

연구 보고서

• 연구 주제, 연구 목적
• 연구 범위 및 제약 조건
• 비교 대상 (해당 시)

---

4. 템플릿별 사용법

4.1 프로젝트 계획서 (planner-template.md)

핵심 섹션 (6개)

섹션	내용	필수 여부
1. 프로젝트 개요	배경, 목적, 범위, 성공 기준	필수
2. 기술 스택 & 아키텍처	기술 선정, 시스템 구조, 인프라	필수
3. 요구사항 & 기능 명세	기능/비기능 요구사항, API, 데이터 모델	필수
4. 일정 & 마일스톤	타임라인, WBS, 리소스 계획	필수
5. 위험 관리	위험 식별, 완화 전략	선택
6. 부록	용어 정의, 참고 문서	선택

특징

• Mermaid 다이어그램 포함 (아키텍처, Gantt, ERD)
• [선택사항: project-type] 마커로 프로젝트 유형별 섹션 구분
• 프로젝트 유형: web-application, api-service, ai-ml, mobile-app, data-pipeline

4.2 연구 보고서 (research-template.md)

핵심 섹션 (11개)

섹션	내용	필수 여부
1. 연구 개요	주제, 핵심 질문, 요약	필수
2. 연구 목적	목적, 연구 질문, 기대 효과	필수
3. 배경	현황, 문제 정의, 선행 사례	필수
4. 방법론	접근 방식, 데이터 수집, 분석 프레임워크	필수
5. 조사 영역	각 영역별 상세 조사 내용	필수
6. 핵심 발견	발견 사항 요약, 상세, 예상치 못한 발견	필수
7. 분석	비교, SWOT, 트레이드오프, 리스크 분석	필수
8. 권고사항	단기/중기/장기 권고, 비권고 사항	필수
9. 결론	목적 달성 여부, 최종 결론, 한계점	필수
10. 참고자료	문헌, 온라인 자료, 기술 문서	선택
11. 부록	용어 정의, 상세 데이터	선택

특징

• 연구 유형: 기술 연구, 시장 분석, 문제 해결 연구, 일반 조사
• SWOT 분석, 비교 분석 테이블 포함
• 권고사항에 우선순위, 난이도, 소요 기간 명시

---

5. 사용 예시

예시 1: 프로젝트 계획서 요청

사용자 요청:

새로운 이커머스 플랫폼 개발 계획서를 작성해줘

에이전트 응답:

프로젝트 계획서를 작성하겠습니다. 몇 가지 확인이 필요합니다:

1. 프로젝트명은 무엇인가요?
2. 주요 기능 요구사항은 무엇인가요? (예: 상품 관리, 결제, 배송 등)
3. 선호하는 기술 스택이 있나요?
4. 예상 일정이나 마일스톤이 있나요?

[정보 수집 후 planner-template.md 기반으로 계획서 작성]

예시 2: 연구 보고서 요청

사용자 요청:

React vs Vue 프레임워크 비교 분석 보고서를 작성해줘

에이전트 응답:

기술 비교 연구 보고서를 작성하겠습니다.

연구 주제: React vs Vue 프레임워크 비교 분석
연구 유형: 기술 연구

[research-template.md 기반으로 보고서 작성]
- 비교 기준 설정 (성능, 학습 곡선, 생태계, 커뮤니티 등)
- 각 프레임워크별 조사
- 비교 분석 테이블 작성
- 상황별 권고사항 도출

예시 3: 유형 모호한 경우

사용자 요청:

신규 서비스에 대한 문서를 작성해줘

에이전트 응답:

어떤 유형의 문서를 작성할까요?

1. **프로젝트 계획서** - 개발 계획, 기술 스택, 일정, 마일스톤 중심
2. **연구 보고서** - 기술 조사, 비교 분석, 권고사항 중심

[사용자 선택 후 해당 템플릿으로 진행]

---

6. 주의사항

작성 원칙

1. 템플릿 구조 준수: 템플릿의 섹션 구조와 순서를 유지
2. 플레이스홀더 완전 대체: 모든 {{PLACEHOLDER}}를 실제 내용으로 대체
3. 가이드 주석 제거: 최종 문서에서 <!-- Agent: ... --> 주석 제거
4. 적절한 상세 수준: 문서 목적에 맞는 상세 수준 유지

품질 체크리스트

• 모든 필수 섹션이 포함되었는가?
• 플레이스홀더가 모두 대체되었는가?
• 에이전트 가이드 주석이 제거되었는가?
• 문서 유형에 맞는 섹션만 포함되었는가?
• 내용이 일관성 있고 논리적인가?

---

7. 향후 확장

새로운 템플릿 추가 예정:

템플릿	용도	상태
report-template.md	일반 업무 보고서	예정
proposal-template.md	제안서, 기획안	예정
spec-template.md	기술 명세서	예정

템플릿 추가 시 이 스킬 문서의 감지 규칙과 가이드를 함께 업데이트합니다.