Agent skill

documentation

Generate and update project documentation following acidApps standards. Includes templates for README, USER_MANUAL, TERMINOLOGY, and CHANGELOG.

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/documentation-acidsound-acidapps

SKILL.md

๐Ÿ“ Documentation Skill

ํ”„๋กœ์ ํŠธ ๋ฌธ์„œ ์ƒ์„ฑ ๋ฐ ๊ฐฑ์‹ ์„ ์œ„ํ•œ ๊ฐ€์ด๋“œ.

๐ŸŽฏ ์šฉ๋„

  • ์ƒˆ ํ”„๋กœ์ ํŠธ ๋ฌธ์„œ ํ…œํ”Œ๋ฆฟ ์ œ๊ณต
  • ๊ธฐ์กด ๋ฌธ์„œ ์—…๋ฐ์ดํŠธ ๊ฐ€์ด๋“œ
  • ๋‹ค๊ตญ์–ด ๋ฌธ์„œ ๋™๊ธฐํ™”

๐Ÿ“‹ ํ•„์ˆ˜ ๋ฌธ์„œ ๋ชฉ๋ก

๋ฌธ์„œ ์šฉ๋„ ์šฐ์„ ์ˆœ์œ„
README.md ํ”„๋กœ์ ํŠธ ๊ฐœ์š”, ์‹œ์ž‘ ๊ฐ€์ด๋“œ ๐Ÿ”ด ํ•„์ˆ˜
USER_MANUAL.md ์‚ฌ์šฉ์ž ๋งค๋‰ด์–ผ ๐Ÿ”ด ํ•„์ˆ˜
CHANGELOG.md ๋ณ€๊ฒฝ ์ด๋ ฅ ๐ŸŸก ๊ถŒ์žฅ
TERMINOLOGY.md ์šฉ์–ด ์ •์˜ ๐ŸŸก ๊ถŒ์žฅ
.agent/PROJECT_CONTEXT.md AI ์—์ด์ „ํŠธ์šฉ ํ”„๋กœ์ ํŠธ ์ •๋ณด ๐ŸŸข ์„ ํƒ

๐Ÿ“„ ํ…œํ”Œ๋ฆฟ

README.md

markdown
# ๐ŸŽน [์•ฑ ์ด๋ฆ„]

**[์•ฑ ์ด๋ฆ„]**์€ [ํ•œ ์ค„ ์„ค๋ช…].

๐ŸŽต **[Live Demo](https://your-url.github.io/app/)**

## โœจ ์ฃผ์š” ๊ธฐ๋Šฅ

- **๊ธฐ๋Šฅ 1**: ์„ค๋ช…
- **๊ธฐ๋Šฅ 2**: ์„ค๋ช…

## ๐Ÿ›  ๊ธฐ์ˆ  ์Šคํƒ

- **Framework**: React 19 + Vite
- **Audio**: Web Audio API (AudioWorklet)

## ๐Ÿš€ ์‹œ์ž‘ํ•˜๊ธฐ

\`\`\`bash
git clone https://github.com/user/app.git
cd app
npm install
npm run dev
\`\`\`

## ๐Ÿ“– ๋ฌธ์„œ

- [์‚ฌ์šฉ์ž ๋งค๋‰ด์–ผ](./USER_MANUAL.md)

USER_MANUAL.md

markdown
# ๐Ÿ“– [์•ฑ ์ด๋ฆ„] ์‚ฌ์šฉ์ž ๋งค๋‰ด์–ผ

## ๐Ÿ•น๏ธ ์ธํ„ฐํŽ˜์ด์Šค ๊ตฌ์„ฑ

### 1. ํ—ค๋” ์˜์—ญ
- **๋กœ๊ณ **: [๊ธฐ๋Šฅ]
- **๋””์Šคํ”Œ๋ ˆ์ด**: [ํ‘œ์‹œ ์ •๋ณด]

### 2. ๋ฉ”์ธ ์˜์—ญ
- **ํŒจ๋“œ/๊ฑด๋ฐ˜**: [์‚ฌ์šฉ๋ฒ•]

## ๐ŸŽน ๊ธฐ๋ณธ ์กฐ์ž‘

### ์‚ฌ์šด๋“œ ์žฌ์ƒ
1. [๋‹จ๊ณ„ 1]
2. [๋‹จ๊ณ„ 2]

## โŒจ๏ธ ํ‚ค๋ณด๋“œ ๋‹จ์ถ•ํ‚ค

| ํ‚ค | ๋™์ž‘ |
|----|------|
| Space | ์žฌ์ƒ/์ •์ง€ |

## ๐ŸŒ ์‹œ์Šคํ…œ ์š”๊ตฌ์‚ฌํ•ญ

- **๋ธŒ๋ผ์šฐ์ €**: Chrome, Edge, Safari

CHANGELOG.md

markdown
# ๐Ÿ“‹ ๋ณ€๊ฒฝ ์ด๋ ฅ

## [Unreleased]

### Added
- ์ƒˆ ๊ธฐ๋Šฅ

### Changed
- ๋ณ€๊ฒฝ ์‚ฌํ•ญ

### Fixed
- ๋ฒ„๊ทธ ์ˆ˜์ •

---

## [1.0.0] - 2026-01-25

### Added
- ์ดˆ๊ธฐ ๋ฆด๋ฆฌ์ฆˆ

TERMINOLOGY.md

markdown
# ๐Ÿ“— ์šฉ์–ด ์ •์˜

## ํ•ต์‹ฌ ๊ฐœ๋…

| ์šฉ์–ด | ๋ฒ”์œ„ | ์ •์˜ |
|------|------|------|
| **Project** | UI/Logic | ์•ฑ์˜ ์ „์ฒด ์ƒํƒœ |
| **Pad** | UI/Logic | ๊ฐœ๋ณ„ ํŠธ๋ฆฌ๊ฑฐ ๋‹จ์œ„ |

## ํŒŒ๋ผ๋ฏธํ„ฐ

| ์šฉ์–ด | ๋ฒ”์œ„ | ์ •์˜ |
|------|------|------|
| **Pitch** | Logic | ์žฌ์ƒ ์†๋„/ํ”ผ์น˜ |

๐Ÿ“ ๋ฌธ์„œ ๊ฐฑ์‹  ์›Œํฌํ”Œ๋กœ์šฐ

1. ๊ธฐ๋Šฅ ์ถ”๊ฐ€ ์‹œ

  1. USER_MANUAL.md์— ์ƒˆ ์„น์…˜ ์ถ”๊ฐ€
  2. CHANGELOG.md์— ํ•ญ๋ชฉ ์ถ”๊ฐ€
  3. README.md ๊ธฐ๋Šฅ ๋ชฉ๋ก ์—…๋ฐ์ดํŠธ (ํ•„์š”์‹œ)
  4. ํ•œ๊ตญ์–ด ๋ฌธ์„œ ๋™๊ธฐํ™” (์žˆ๋Š” ๊ฒฝ์šฐ)

2. UI ๋ณ€๊ฒฝ ์‹œ

  1. ์Šคํฌ๋ฆฐ์ƒท ์žฌ์ƒ์„ฑ (screenshot-generator ์Šคํ‚ฌ ์ฐธ์กฐ)
  2. USER_MANUAL.md ์„ค๋ช… ์—…๋ฐ์ดํŠธ
  3. README.md ์Šคํฌ๋ฆฐ์ƒท ์—…๋ฐ์ดํŠธ

3. API/๊ตฌ์กฐ ๋ณ€๊ฒฝ ์‹œ

  1. TERMINOLOGY.md ์šฉ์–ด ์—…๋ฐ์ดํŠธ
  2. .agent/PROJECT_CONTEXT.md ์•„ํ‚คํ…์ฒ˜ ์—…๋ฐ์ดํŠธ
  3. ๊ฐœ๋ฐœ ๋ฌธ์„œ ์—…๋ฐ์ดํŠธ (docs/DEVELOPMENT.md)

๐ŸŒ ๋‹ค๊ตญ์–ด ๋™๊ธฐํ™”

๋Œ€์ƒ ํŒŒ์ผ

USER_MANUAL.md      โ†’ USER_MANUAL_ko.md
LEARNING_GUIDE.md   โ†’ LEARNING_GUIDE_ko.md (์žˆ๋Š” ๊ฒฝ์šฐ)

๋™๊ธฐํ™” ์ฒดํฌ๋ฆฌ์ŠคํŠธ

  • ์„น์…˜ ๊ตฌ์กฐ ์ผ์น˜
  • ํ—ค๋” ๋ฒˆํ˜ธ/๋ ˆ๋ฒจ ์ผ์น˜
  • ์Šคํฌ๋ฆฐ์ƒท ๊ฒฝ๋กœ ๋™์ผ
  • ํ‚ค๋ณด๋“œ ๋‹จ์ถ•ํ‚ค ํ‘œ ๋™์ผ

๐Ÿ” ๋ฌธ์„œ ๊ฒ€์ฆ

bash
# ๊นจ์ง„ ๋งํฌ ํ™•์ธ
grep -rn "\[.*\](.*)" *.md | grep -v "http"

# ์ด๋ฏธ์ง€ ์กด์žฌ ํ™•์ธ
for img in $(grep -oh "assets/[^)]*" *.md); do
    [ -f "$img" ] || echo "Missing: $img"
done

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results