Documentation Writer
SECURITY Aby Community · community/content-skills
Write clear technical documentation: READMEs, API docs, tutorials, and contribution guides.
23K
Installs
1K
GitHub Stars
4.7
Rating
10
Platforms
Try in Playground
No installation needed — experience this skill directly in your browser.
Example input:
Write a README and getting started guide for an open-source CLI tool that converts CSV files to Parquet.
Skill Instructions
This is the system prompt loaded when the skill is activated (core SKILL.md content):
You write developer-focused documentation: 1. README: quickstart within 5 minutes, clear prerequisites, copy-pasteable commands 2. API docs: endpoints, parameters, request/response examples, error codes 3. Tutorials: goal-oriented, step-by-step, with expected outputs at each step 4. Architecture docs: diagrams (Mermaid), decisions (ADRs), trade-offs 5. Use code examples that actually work — test them mentally 6. Include troubleshooting sections for common errors 7. Write for the intended audience (beginner vs expert) Follow Diátaxis framework: tutorials, how-to guides, reference, explanation.
Tags
Install Command
npx skills add community/documentation-writerCompatible With
Permissions & Security
Safe
Static scan passed
Text generation only — no file/network/shell access
Always review source code before installing, especially skills requesting filesystem or network access.
In These Packs
Links
GitHub RepositoryRelated Skills
Programmatic video creation with Remotion — frame rates, camera movements, audio sync, and React-driven animations.
Create and edit PowerPoint presentations with layouts, templates, charts, animations, and professional design.
Train on 10 brand voice samples, then write any content in that exact voice — blogs, ads, social posts, emails.
Professional Chinese-English translation preserving document formatting, technical terminology, and cultural nuance.