Claude Code skill: genera documentación profesional de entrega de proyectos (README, Guía de Uso, Docs Técnica, .env.example)
Overview
Skill de Claude Code que genera documentación profesional de entrega de proyectos para clientes. Con un solo comando crea con portada, tipografía y formato profesional, listos para entregar. Cada .docx incluye: - con nombre del proyecto, empresa y fecha - con headings estilizados - (default: cyan #00E5FF) - con headers oscuros y filas alternas - con font monospace y fondo gris - del desarrollador (opcional) 1. Te pregunta: nombre del proyecto, cliente, tipo de cliente, URL, tu info de contacto 2. Lee automáticamente todo el código del proyecto (package.json, schema, routes, etc.) 3. Genera los markdowns en docs/entrega/ 4. Los convierte automáticamente a 5. Tú revisas y entregas los .docx al cliente Eso es todo. Ya puedes usar /docs-entrega en cualquier proyecto.
README
docs-entrega — Claude Code Skill
Skill de Claude Code que genera documentación profesional de entrega de proyectos para clientes. Con un solo comando crea documentos Word (.docx) con portada, tipografía y formato profesional, listos para entregar.
Qué genera
| Archivo | Para quién | Contenido |
|---|---|---|
README.docx |
Devs / técnicos | Stack, instalación, estructura, endpoints, env vars |
GUIA-DE-USO.docx |
El cliente | Cómo acceder, cómo usar cada feature, FAQ, soporte |
DOCS-TECNICA.docx |
Mantenimiento futuro | Arquitectura, DB schema, APIs, cómo hacer cambios |
.env.example |
Setup | Todas las variables con comentarios, sin valores reales |
Cada .docx incluye:
- Portada profesional con nombre del proyecto, empresa y fecha
- Tipografía Calibri con headings estilizados
- Color de acento personalizable (default: cyan #00E5FF)
- Tablas formateadas con headers oscuros y filas alternas
- Code blocks con font monospace y fondo gris
- Logo del desarrollador (opcional)
Cómo funciona
/docs-entrega
- Te pregunta: nombre del proyecto, cliente, tipo de cliente, URL, tu info de contacto
- Lee automáticamente todo el código del proyecto (package.json, schema, routes, etc.)
- Genera los markdowns en
docs/entrega/ - Los convierte automáticamente a documentos Word profesionales
- Tú revisas y entregas los
.docxal cliente
Tipos de cliente
| Tipo | Qué recibe | Diferencia en los docs |
|---|---|---|
| Técnico | Repo + servicios + docs completos | Docs detallados con code examples |
| No técnico | Solo usa la app | Guía simplificada, cero jargon |
| Con mantenimiento | Tú sigues como admin | Incluye SLA, horario de soporte |
Instalación
1. Instalar el skill
mkdir -p ~/.claude/skills/docs-entrega
curl -sL https://raw.githubusercontent.com/santmun/docs-entrega-skill/main/SKILL.md \
-o ~/.claude/skills/docs-entrega/SKILL.md
2. Instalar dependencia
pip3 install python-docx
Eso es todo. Ya puedes usar /docs-entrega en cualquier proyecto.
Ejemplo de uso
> /docs-entrega
Para generar la documentación de entrega necesito algunos datos:
1. Nombre del proyecto: Invoice Analyzer
2. Cliente: Acme Corp
3. Tipo de cliente: No técnico
4. URL de producción: https://invoices.acme.com
5. Tu info: Santiago Munoz, [email protected], Horizontes IA
6. Color principal: #00E5FF
Generando...
📦 Documentación de entrega generada:
docs/entrega/
├── README.md — Referencia técnica (markdown)
├── README.docx — Referencia técnica (Word)
├── GUIA-DE-USO.md — Guía para el cliente (markdown)
├── GUIA-DE-USO.docx — Guía para el cliente (Word)
├── DOCS-TECNICA.md — Docs de mantenimiento (markdown)
├── DOCS-TECNICA.docx — Docs de mantenimiento (Word)
└── .env.example — Template de variables de entorno
📄 Los archivos .docx están listos para enviar al cliente.
Qué incluye cada documento
README.docx — Referencia técnica
- Badges del stack con versiones
- Instalación paso a paso
- Variables de entorno (tabla con descripción + quién las provee)
- Estructura del proyecto con explicaciones
- Endpoints de la API
- Scripts disponibles
- Sección de licencia y propiedad del código
GUIA-DE-USO.docx — Para el cliente
- Cómo acceder (URL + login)
- Cada feature explicada paso a paso
- Preguntas frecuentes
- Qué hacer si algo falla
- Glosario de términos
- Info de soporte y contacto
DOCS-TECNICA.docx — Para mantenimiento
- Diagrama de arquitectura (Mermaid)
- Schema de base de datos (todas las tablas y campos)
- APIs y servicios conectados
- Sección de seguridad y autenticación
- “Cómo hacer cambios comunes” (agregar página, modificar modelo, etc.)
- Servicios de terceros con costos y dashboards
- Deploy, CI/CD y rollback
- Monitoreo, logs y backups
.env.example — Variables de entorno
- Variables agrupadas por función (DB, Auth, APIs, Public)
- Comentarios con dashboard URL de cada servicio
- Marcado de quién es dueño de cada key (Cliente / Servicio / Developer)
- Warnings en keys sensibles
Personalización
| Opción | Descripción | Default |
|---|---|---|
| Color de acento | Hex color para headings y highlights | #00E5FF |
| Logo | Imagen PNG/JPG para la portada | Ninguno |
| Idioma | Español o inglés | Español |
| Empresa | Nombre en la portada y footer | — |
Seguridad
El skill nunca incluye valores reales de API keys o secrets. Solo genera:
- Nombres de variables
- Descripciones
- Placeholders vacíos
Siempre revisa los documentos antes de entregarlos.
Requisitos
- Claude Code instalado
- Python 3.10+
python-docx(pip3 install python-docx)- Estar en el directorio raíz del proyecto a documentar
Archivos del repo
| Archivo | Qué hace |
|---|---|
SKILL.md |
El skill de Claude Code (va en ~/.claude/skills/docs-entrega/) |
md_to_docx.py |
Conversor de Markdown a Word con formato profesional |
README.md |
Este archivo |
Creado por
Horizontes IA — Educación y automatización con IA en español.
License
MIT
Recommended Tools
Try a different keyword or remove a filter.
Install
npx skillfish add santmun/docs-entrega-skill