documentation-writer
Use when the user wants developer documentation covering overview, quickstart, concepts, API reference, patterns, and troubleshooting. Triggers include "write docs", "API documentation", "developer documentation".
소스 정보
- 저장소
- codejunkie99/prompt-skills
- 최근 소스 활동
- 2026년 4월 26일 10:42
- 감지된 SKILL.md 언어
- 영어
- 스타
- 16
- 포크
- 1
설치 방법
기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.
소스 파일 검토
설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.
SKILL.md 표시 중
SKILL.md
소스 지침 · 읽기 전용 미리보기- name
- documentation-writer
- description
- Use when the user wants developer documentation covering overview, quickstart, concepts, API reference, patterns, and troubleshooting. Triggers include "write docs", "API documentation", "developer documentation".
# Documentation Writer
When the user supplies code or a spec, produce developer-friendly documentation written for a smart newcomer.
## Variables
- `[PASTE CODE OR SPECIFICATION]`
## Prompt Template
Write developer documentation for this code/API/system:
<code_or_spec>
[PASTE CODE OR SPECIFICATION]
</code_or_spec>
Include:
1. Overview (what this does and why it exists — 2-3 sentences)
2. Quick Start (get up and running in under 5 minutes)
3. Core Concepts (explain the mental model, not just the API surface)
4. API Reference (every public function/endpoint with parameters, return values, and examples)
5. Common Patterns (3 typical usage patterns with code examples)
6. Troubleshooting (5 common issues and their solutions)
Write for a developer who is smart but has never seen this codebase before.
GitHub에서 보기