por Juanjo LunaMejorar documentación técnica
Te ayuda a escribir, revisar y aclarar documentación para desarrolladores con un estilo consistente y fácil de seguir. Sirve cuando un README, una guía o una referencia de API están confusos.
Descripción original (inglés)
technical-documentation: Audit, write, and improve developer documentation using Google''s Developer Documentation Style Guide and Technical Writing courses. Use this skill for any documentation work, even when the user names no style guide: "audit our docs", "review this README", "write a README", "getting started guide", "how-to or tutorial", "API reference", "docstrings", "CLI help text", "changelog or release notes", "migration guide", or "our docs are confusing". Also use it when writing docs from code, rewriting a doc for clarity, fixing headings, procedures, or code samples, or enforcing consistent voice and terminology across a docs set — prefer it over editing documentation unaided. Covers reader and doc-type fit, second person and active voice, procedures, headings, lists and tables, code samples and placeholders, link text, notices, the word list, timeless docs, and accessibility. For code comments and naming, see clean-code. For marketing or landing-page copy, see storybrand-messaging.
Cómo instalarla
Una skill es una carpeta con un fichero SKILL.md. Para instalarla basta con copiar la carpeta technical-documentation en el sitio donde tu agente busca sus skills.
- Sin terminal: abre la carpeta en GitHub, descárgala y cópiala en la carpeta de tu agente (tabla de abajo).
- Con terminal (macOS, Linux o Git Bash en Windows): elige tu agente y copia los comandos.
git clone --depth 1 https://github.com/wondelai/skills.git /tmp/skill-src
mkdir -p ~/.claude/skills
cp -r "/tmp/skill-src/plugins/code-craftsmanship/skills/technical-documentation" ~/.claude/skills/technical-documentation
rm -rf /tmp/skill-src| Agente | Para todos tus proyectos | Solo un proyecto |
|---|---|---|
| Claude Code | ~/.claude/skills | .claude/skills |
| GitHub Copilot | ~/.copilot/skills | .github/skills |
| Codex | ~/.agents/skills | .agents/skills |
| Gemini CLI | ~/.gemini/skills | .gemini/skills |
Muchos agentes leen también .agents/skills. Reinicia el agente después de instalar. Antes de instalar una skill, revisa su SKILL.md y los scripts que incluya: se ejecutan con tus permisos.
Más skills de wondelai/skills
- Construir productos al estilo 37signals 37signals-way
- Optimizar arquitectura de código existente architecture-optimization
- Crear estrategia de océano azul blue-ocean-strategy
- Diseñar arquitectura limpia clean-architecture
- Escribir código limpio clean-code
- Lanzar productos con red de usuarios cold-start-problem
- Crear productos que se comparten contagious
- Hacer discovery continuo con clientes continuous-discovery
Explicación redactada con ayuda de IA a partir de la descripción original.