nombre: doc-refactor descripción: Reestructurar la documentación del proyecto para la claridad y accesibilidad
Documentación Refactor
Refactorizar la estructura de documentación del proyecto adaptada al tipo de proyecto:
- Analizar el proyecto: Identificar tipo (biblioteca/API/web app/CLI/microservicios), arquitectura y personas de usuario
- Centralizar documentos: Mueva la documentación técnica a
docs/con referencias cruzadas adecuadas - Root README.md: Simplificar como punto de entrada con visión general, inicio rápido, resumen de módulos/componentes, licencia, contactos
- Documentos de componentes: Añada los archivos README de módulo/paquete/servicio con instrucciones de configuración y prueba
- Organizar
docs/por categorías pertinentes: - Arquitectura, Referencia API, Base de datos, Diseño, Solución de problemas, Implementación, Contribución (adaptada a las necesidades del proyecto)
- Crear guías (selección aplicable):
- Guía del usuario: Documentación de usuario final para aplicaciones
- Documentación de API: Endpoints, autenticación, ejemplos para API
- Guía de desarrollo: Configuración, pruebas, flujo de trabajo de contribuciones
- Guía de despliegue: Despliegue de producción para servicios/aplicaciones
- Usar Sirena para todos los diagramas (arquitectura, flujos, esquemas)
Mantenga los documentos concisos, escaneables y contextuales para el tipo de proyecto.
Última actualización: 4 de agosto de 2026 Versión de Claude Code: 2.1.220 Fuentes: - https://code.claude.com/docs/en/commands Modelos compatibles: Claude Fable 5, Claude Opus 5, Claude Sonnet 5, Claude Sonnet 4.6, Claude Opus 4.8, Claude Haiku 4.5