Agent skill
documentation
Generate and update project documentation following acidApps standards. Includes templates for README, USER_MANUAL, TERMINOLOGY, and CHANGELOG.
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
# ๐น [์ฑ ์ด๋ฆ]
**[์ฑ ์ด๋ฆ]**์ [ํ ์ค ์ค๋ช
].
๐ต **[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
# ๐ [์ฑ ์ด๋ฆ] ์ฌ์ฉ์ ๋งค๋ด์ผ
## ๐น๏ธ ์ธํฐํ์ด์ค ๊ตฌ์ฑ
### 1. ํค๋ ์์ญ
- **๋ก๊ณ **: [๊ธฐ๋ฅ]
- **๋์คํ๋ ์ด**: [ํ์ ์ ๋ณด]
### 2. ๋ฉ์ธ ์์ญ
- **ํจ๋/๊ฑด๋ฐ**: [์ฌ์ฉ๋ฒ]
## ๐น ๊ธฐ๋ณธ ์กฐ์
### ์ฌ์ด๋ ์ฌ์
1. [๋จ๊ณ 1]
2. [๋จ๊ณ 2]
## โจ๏ธ ํค๋ณด๋ ๋จ์ถํค
| ํค | ๋์ |
|----|------|
| Space | ์ฌ์/์ ์ง |
## ๐ ์์คํ
์๊ตฌ์ฌํญ
- **๋ธ๋ผ์ฐ์ **: Chrome, Edge, Safari
CHANGELOG.md
# ๐ ๋ณ๊ฒฝ ์ด๋ ฅ
## [Unreleased]
### Added
- ์ ๊ธฐ๋ฅ
### Changed
- ๋ณ๊ฒฝ ์ฌํญ
### Fixed
- ๋ฒ๊ทธ ์์
---
## [1.0.0] - 2026-01-25
### Added
- ์ด๊ธฐ ๋ฆด๋ฆฌ์ฆ
TERMINOLOGY.md
# ๐ ์ฉ์ด ์ ์
## ํต์ฌ ๊ฐ๋
| ์ฉ์ด | ๋ฒ์ | ์ ์ |
|------|------|------|
| **Project** | UI/Logic | ์ฑ์ ์ ์ฒด ์ํ |
| **Pad** | UI/Logic | ๊ฐ๋ณ ํธ๋ฆฌ๊ฑฐ ๋จ์ |
## ํ๋ผ๋ฏธํฐ
| ์ฉ์ด | ๋ฒ์ | ์ ์ |
|------|------|------|
| **Pitch** | Logic | ์ฌ์ ์๋/ํผ์น |
๐ ๋ฌธ์ ๊ฐฑ์ ์ํฌํ๋ก์ฐ
1. ๊ธฐ๋ฅ ์ถ๊ฐ ์
USER_MANUAL.md์ ์ ์น์ ์ถ๊ฐCHANGELOG.md์ ํญ๋ชฉ ์ถ๊ฐREADME.md๊ธฐ๋ฅ ๋ชฉ๋ก ์ ๋ฐ์ดํธ (ํ์์)- ํ๊ตญ์ด ๋ฌธ์ ๋๊ธฐํ (์๋ ๊ฒฝ์ฐ)
2. UI ๋ณ๊ฒฝ ์
- ์คํฌ๋ฆฐ์ท ์ฌ์์ฑ (
screenshot-generator์คํฌ ์ฐธ์กฐ) USER_MANUAL.md์ค๋ช ์ ๋ฐ์ดํธREADME.md์คํฌ๋ฆฐ์ท ์ ๋ฐ์ดํธ
3. API/๊ตฌ์กฐ ๋ณ๊ฒฝ ์
TERMINOLOGY.md์ฉ์ด ์ ๋ฐ์ดํธ.agent/PROJECT_CONTEXT.md์ํคํ ์ฒ ์ ๋ฐ์ดํธ- ๊ฐ๋ฐ ๋ฌธ์ ์
๋ฐ์ดํธ (
docs/DEVELOPMENT.md)
๐ ๋ค๊ตญ์ด ๋๊ธฐํ
๋์ ํ์ผ
USER_MANUAL.md โ USER_MANUAL_ko.md
LEARNING_GUIDE.md โ LEARNING_GUIDE_ko.md (์๋ ๊ฒฝ์ฐ)
๋๊ธฐํ ์ฒดํฌ๋ฆฌ์คํธ
- ์น์ ๊ตฌ์กฐ ์ผ์น
- ํค๋ ๋ฒํธ/๋ ๋ฒจ ์ผ์น
- ์คํฌ๋ฆฐ์ท ๊ฒฝ๋ก ๋์ผ
- ํค๋ณด๋ ๋จ์ถํค ํ ๋์ผ
๐ ๋ฌธ์ ๊ฒ์ฆ
# ๊นจ์ง ๋งํฌ ํ์ธ
grep -rn "\[.*\](.*)" *.md | grep -v "http"
# ์ด๋ฏธ์ง ์กด์ฌ ํ์ธ
for img in $(grep -oh "assets/[^)]*" *.md); do
[ -f "$img" ] || echo "Missing: $img"
done
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?