📚
Documentation Writer
SECURITY Aby Community · community/content-skills
撰写清晰的技术文档：README、API文档、教程和贡献指南。
23K
安装量
1K
GitHub Stars
4.7
评分
10
兼容平台
技能指令预览
以下是该 Skill 加载到 AI 时的系统指令（SKILL.md 核心内容）：
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.
标签
documentationtechnical writingREADMEAPI docsguides
安装命令
npx skills add community/documentation-writer兼容平台
Claude Code
Cursor
GitHub Copilot
OpenAI Codex
Gemini CLI
Windsurf
Goose
OpenCode
Cline
Roo Code
权限与安全
A
安全
静态扫描通过
✓
纯文本low
Text generation only — no file/network/shell access
建议安装前审查源码，特别是请求文件系统或网络访问权限的技能。