문서 템플릿 스킬
README.md 템플릿
markdown
1# 프로젝트명
2
3프로젝트 한 줄 설명
4
5## 주요 기능
6
7- 기능 1
8- 기능 2
9- 기능 3
10
11## 기술 스택
12
13- Next.js 14
14- TypeScript
15- Tailwind CSS
16
17## 시작하기
18
19### 요구사항
20
21- Node.js 18+
22- npm 또는 yarn
23
24### 설치
25
26\`\`\`bash
27git clone https://github.com/user/repo.git
28cd repo
29npm install
30\`\`\`
31
32### 환경 설정
33
34\`\`\`bash
35cp .env.example .env.local
36# .env.local 파일 수정
37\`\`\`
38
39### 실행
40
41\`\`\`bash
42npm run dev
43\`\`\`
44
45http://localhost:3000 에서 확인
46
47## 프로젝트 구조
48
49\`\`\`
50app/
51├── components/ # 재사용 컴포넌트
52├── api/ # API 라우트
53├── (routes)/ # 페이지 라우트
54└── lib/ # 유틸리티
55\`\`\`
56
57## 라이선스
58
59MIT License
컴포넌트 문서 템플릿
markdown
1# ComponentName
2
3컴포넌트 설명
4
5## Props
6
78|------|------|---------|-------------|
9| required | string | - | 필수 prop 설명 |
10| optional | number | 0 | 선택 prop 설명 |
11
12## 사용 예시
13
14\`\`\`tsx
15import { ComponentName } from '@/components/ComponentName';
16
17<ComponentName required="value" optional={10} />
18\`\`\`
19
20## 변형
21
22### Primary
23
24\`\`\`tsx
25<ComponentName variant="primary" />
26\`\`\`
27
28### Secondary
29
30\`\`\`tsx
31<ComponentName variant="secondary" />
32\`\`\`
API 문서 템플릿
markdown
1# API 엔드포인트
2
3## POST /api/auth/login
4
5사용자 로그인
6
7### Request
8
9\`\`\`json
10{
11 "email": "user@example.com",
12 "password": "password123"
13}
14\`\`\`
15
16### Response
17
18**Success (200)**
19\`\`\`json
20{
21 "success": true,
22 "data": {
23 "token": "jwt-token",
24 "user": { "id": 1, "email": "user@example.com" }
25 }
26}
27\`\`\`
28
29**Error (401)**
30\`\`\`json
31{
32 "success": false,
33 "error": "Invalid credentials"
34}
35\`\`\`
CHANGELOG 템플릿
markdown
1# Changelog
2
3## [1.0.0] - 2025-01-28
4
5### Added
6- 새로운 기능
7
8### Changed
9- 변경된 기능
10
11### Fixed
12- 수정된 버그
13
14### Removed
15- 제거된 기능
사용 예시
documentation-writer 에이전트로 이 프로젝트의 README를 작성해줘
