El CLI estaba listo. Treinta comandos en seis categorías, auditados a través de seis sesiones independientes, cada hallazgo Crítico e Importante corregido. El código funcionaba.
Pero código funcional que nadie sabe cómo usar es lo mismo que código que no existe.
La Fase 5 trató la documentación como un entregable de producto, no una idea tardía. Tres superficies, cuatro páginas de docs, cinco idiomas, una sesión.
Tres superficies, tres audiencias
1. La página de marketing (sh0.dev/cli)
Audiencia: Desarrolladores evaluando sh0 por primera vez.
Objetivo: Mostrar, no contar. La página muestra la experiencia de terminal y hace una promesa.
2. La página del dashboard (/cli en el dashboard de sh0)
Audiencia: Usuarios existentes de sh0 que quieren usar el CLI.
Objetivo: Llevarlos de cero a productivos en una página. Localizada en cinco idiomas.
3. Las páginas de documentación (sh0.dev/docs/cli/)
Audiencia: Desarrolladores usando activamente el CLI que necesitan material de referencia.
Objetivo: Completa, precisa y buscable. Cuatro páginas cubren el CLI completo.
El problema de deuda de documentación
La Fase 5 se ejecutó dos veces. El primer pase documentó solo los comandos iniciales. Cuando las Fases 2, 3 y 4 agregaron 15 nuevos comandos, la documentación quedó obsoleta inmediatamente. Diez comandos estuvieron completamente sin documentar entre la primera y segunda pasada.
La estrategia i18n
Los nombres de comandos y la salida de terminal no se traducen -- sh0 push es sh0 push en cada idioma. Solo el texto UI circundante se localiza. Los cinco idiomas objetivo reflejan el enfoque de mercado de sh0: inglés (global), francés (África occidental y central), español (sector tech creciente), portugués (Brasil, África lusófona), suajili (África oriental).
Cómo se ve la buena documentación CLI
- Muestra la salida de terminal, no solo el comando.
- Agrupa por flujo de trabajo, no por alfabeto.
- Pon los comandos peligrosos al final y márcalos.
- Un ejemplo por comando, no cinco. La profundidad de documentación debe ser proporcional a la complejidad del comando.
Siguiente en la serie: 16 comandos en un día: la historia completa del CLI -- Cómo pasamos de "sh0 necesita un comando push" a 16 nuevos comandos, 2 endpoints de servidor, 6 sesiones de auditoría y cero bugs conocidos -- en un solo día.