76 lines
3.1 KiB
Markdown
76 lines
3.1 KiB
Markdown
# Plan: Estandarización de Ayudas en Pantalla para Herramientas ADN
|
|
|
|
**Fecha:** 17 de marzo de 2026
|
|
**Autor:** Sistema ADN
|
|
**Versión:** 1.0
|
|
**Ubicación:** `docs/ambito/dtic-ADN/plan/P2604.01.01_Estandarizacion-Ayudas-ADN.md`
|
|
**Estado:** ⏳ En Ejecución
|
|
|
|
## 📋 Resumen Ejecutivo
|
|
|
|
Estandarizar el formato y contenido de las ayudas en pantalla (--help) para todas las herramientas del ecosistema ADN, utilizando el formateador de ayuda estandarizado (`adn/tools/core/help_formatter.rb`) para garantizar consistencia, reutilización y mantenibilidad.
|
|
|
|
## 📅 Fases de Implementación
|
|
|
|
### ✅ **FASE 1: Análisis y Creación de Estándar (Completado)**
|
|
|
|
#### Semana 1: Análisis Inicial
|
|
- [x] **1.1:** Análisis de ayudas actuales en subcomandos CLI
|
|
- [x] **1.2:** Creación de plantilla estándar de ayuda usando HelpFormatter
|
|
|
|
#### Semana 2: Implementación Crítica
|
|
- [x] **1.3:** Actualización de subcomando principal (ayuda.rb)
|
|
- [x] **1.4:** Actualización de subcomandos críticos (jornada.rb, nodos.rb, db.rb)
|
|
- [x] **1.5:** Actualización de subcomandos intermedios (generar.rb, proceso.rb, conocimiento.rb)
|
|
|
|
#### Semana 3: Implementación Completa
|
|
- [x] **1.6:** Actualización de subcomandos (msp.rb, ssh.rb, triggers.rb, contexto.rb, backup.rb ✅) y pendientes (plan.rb, tailscale.rb, estados.rb, salud.rb, validador.rb, wzombi.rb 📍)
|
|
- [ ] **1.7:** Verificación y pruebas de consistencia
|
|
|
|
### ⏳ **FASE 2: Documentación y Soporte (Pendiente)**
|
|
|
|
#### Semana 4: Documentación
|
|
- [ ] **2.1:** Documentación de guías para desarrolladores sobre el nuevo estándar
|
|
- [ ] **2.2:** Integración de verificaciones automáticas en CI (si aplica)
|
|
|
|
## 🔧 Herramientas Utilizadas
|
|
|
|
- Ruby CLI (ADN): Subcomandos en `adn/tools/cli/` que requieren estandarización de ayuda
|
|
- Help Formatter (`adn/tools/core/help_formatter.rb`): Componente central para formateo consistente de ayudas
|
|
|
|
## 👥 Stakeholders
|
|
|
|
| Rol | Persona | Visibilidad |
|
|
| :--- | :--- | :--- |
|
|
| **Responsable Técnico** | Lic. Ricardo MONLA | Operador directo |
|
|
| **Dirección de TIC** | (Jerárquico superior) | Dashboard asíncrono |
|
|
| **Desarrolladores ADN** | Equipo de desarrollo | Uso diario de herramientas |
|
|
|
|
## 🖥️ Nodos Involucrados
|
|
|
|
Este proyecto se enfoca en las herramientas CLI del ecosistema ADN, por lo que no involucra nodos de infraestructura específicos. Los cambios se aplicarán a nivel de código en el repositorio.
|
|
|
|
## 📊 Progreso
|
|
|
|
```
|
|
Fase 1: ████████░░ 85% Implementación (85% completado)
|
|
Fase 2: ░░░░░░░░░░ 0% Documentación y Soporte
|
|
```
|
|
|
|
## 📖 Comandos ADN (Referencia)
|
|
|
|
```bash
|
|
# Ver ayuda principal
|
|
./adn/tools/run ayuda
|
|
|
|
# Ver ayuda de un subcomando específico
|
|
./adn/tools/run ayuda jornada
|
|
./adn/tools/run ayuda nodos
|
|
./adn/tools/run ayuda db
|
|
```
|
|
|
|
## 🔗 Referencias
|
|
|
|
- **ADN**: [Principios Rectores](../../../adn/06_gobernanza.md) | [Herramienta CLI](../../../adn/README.md#herramienta-cli-adn-toolsrun)
|
|
- **Help Formatter**: [`adn/tools/core/help_formatter.rb`](../../../adn/tools/core/help_formatter.rb)
|
|
- **Subcomandos CLI**: [`adn/tools/cli/`](../../../adn/tools/cli/) |