Curso – Claude

Complemento de documentación

Generación y mantenimiento de documentación integral para su proyecto.

Características

Generación de documentación API Creación y actualizaciones de README Sincronización de documentación Mejoras de comentarios de código Generación de ejemplos

Instalación

claude --plugin-dir ./07-plugins/documentation

Lo que está incluido

Comandos de barra

  • /generate-api-docs - Generar documentación API
  • /generate-readme - Crear o actualizar README
  • /sync-docs - Sincronizar documentos con cambios de código
  • /validate-docs - Validar la documentación

Subagentes

  • api-documenter - Especialista en documentación de API
  • code-commentator - Mejoras en los comentarios de código
  • example-generator - Creación de un ejemplo de código

Plantillas

  • api-endpoint.md - Plantilla de documentación de endpoint API
  • function-docs.md - Plantilla de documentación de funciones
  • adr-template.md - Plantilla para el Registro de Decisiones de Arquitectura

Servidores MCP

  • Integración de GitHub para sincronización de documentación

Uso

Generar documentación de API

/generate-api-docs

Crear README

/generate-readme

Sincronizar documentación

/sync-docs

Validar la documentación

/validate-docs

Necesidades

  • Claude Code 2.1+
  • Acceso GitHub (opcional)

Ejemplo de flujo de trabajo

User: /generate-api-docs

Claude:
1. Scans all API endpoints in /src/api/
2. Delegates to api-documenter subagent
3. Extracts function signatures and JSDoc
4. Organizes by module/endpoint
5. Uses api-endpoint.md template
6. Generates comprehensive markdown docs
7. Includes curl, JavaScript, and Python examples

Result:
✅ API documentation generated
📄 Files created:
   - docs/api/users.md
   - docs/api/auth.md
   - docs/api/products.md
📊 Coverage: 23/23 endpoints documented

Uso de plantillas

Plantilla de punto final de API

Utilizar para documentar los puntos finales de la API de REST con ejemplos completos.

Plantilla de documentación de funciones

Uso para documentar funciones/métodos individuales.

Plantilla ADR

Uso para documentar decisiones arquitectónicas.

Configuración

Configure GitHub token para la sincronización de documentación:

export GITHUB_TOKEN="your_github_token"

Mejores prácticas

  • Mantenga la documentación cerca del código
  • Actualizar documentos con cambios de código
  • Incluir ejemplos prácticos
  • Validar regularmente
  • Usar plantillas para obtener consistencia

Última actualización: 18 de octubre de 2026 Versión de Claude Code: 2.1.302 Fuentes- https://code.claude.com/docs/en/plugins - https://github.com/anthropics/claude-code/releases/tag/v2.1.131 - https://github.com/anthropics/claude-code/releases/tag/v2.1.138 - https://code.claude.com/docs/en/model-config - https://code.claude.com/docs/en/plugins/cli-reference - https://code.claude.com/docs/en/plugins/install Modelos compatibles: Claude Fable 5, Claude Opus 5, Claude Sonnet 5, Claude Sonnet 4.6, Claude Opus 4.8, Claude Haiku 4.5

Versión en español de Cris Severin. Basado en Claude How To de luongnv89, bajo licencia MIT. Proyecto original