From alfred-dev
Generates structured user and developer guides with sections for installation, configuration, basic/advanced usage, troubleshooting tables, and FAQs, tailored to audience needs.
npx claudepluginhub 686f6c61/alfred-dev --plugin alfred-devThis skill uses the workspace's default tool permissions.
Este skill genera guías de usuario o de desarrollador claras y completas. Una buena guía permite al lector ir de "no sé nada de esto" a "lo tengo funcionando y entiendo cómo usarlo" sin necesidad de ayuda externa. El tono es directo, los pasos son verificables y los ejemplos son funcionales.
Generates troubleshooting guides, step-by-step instructions, configurations, and best practices for technical documentation tasks like API docs, user guides, and architecture docs.
Creates user guides, tutorials, how-to docs, and step-by-step instructions with screenshots and examples. Use when writing product manuals, getting started guides, or tutorials.
Creates technical documentation for APIs (OpenAPI specs), user guides, tutorials, reference materials, and architecture. Use when documenting code, APIs, or projects.
Share bugs, ideas, or general feedback.
Este skill genera guías de usuario o de desarrollador claras y completas. Una buena guía permite al lector ir de "no sé nada de esto" a "lo tengo funcionando y entiendo cómo usarlo" sin necesidad de ayuda externa. El tono es directo, los pasos son verificables y los ejemplos son funcionales.
La guía se adapta al público: si es para usuarios finales, se evita jerga técnica; si es para desarrolladores, se incluyen detalles de configuración e integración.
Identificar al público objetivo. La guía se escribe de forma distinta según quién la va a leer:
Redactar la sección de instalación. Paso a paso, sin saltar nada:
Redactar la sección de configuración:
Redactar la sección de uso básico. El caso de uso más simple para que el lector vea resultados rápido:
Redactar la sección de uso avanzado. Funcionalidades menos obvias pero importantes:
Redactar la sección de troubleshooting. Los problemas más comunes y sus soluciones:
| Problema | Causa probable | Solución |
|---|---|---|
| Error X al arrancar | Falta variable de entorno Y | Añadir Y al fichero .env |
| La página no carga | Puerto ocupado | Cambiar el puerto en config |
Esta sección se alimenta de las preguntas reales de los usuarios. Si no hay histórico, anticipar los problemas más probables.
Redactar FAQ. Preguntas frecuentes que no encajan en las secciones anteriores. Formato pregunta-respuesta, directo y conciso.
Revisar con un lector fresco. Si es posible, pedir a alguien que no conoce el proyecto que siga la guía y reporte dónde se atasca.