Bootstrap de documentación
Esta es una tarea masiva ocasional. Para cambios posteriores, usa engineering:documentation-sync.
1. Inventario
Enumera los documentos que existen y marca cada uno como presente, fino (existe pero está casi vacío o desactualizado) o faltante. Verifica al menos:
README.md, CONTRIBUTING.md, CHANGELOG.md, ARCHITECTURE.md o docs/architecture/, registros de decisiones, CLAUDE.md, SECURITY.md, LICENSE, la referencia de la API, la referencia de configuración, runbooks.
git ls-files '*.md' | grep -v node_modules
2. Deja que el usuario elija
Muestra el menú de resources/doc-catalog.md. Marca cada tipo como presente, fino o faltante. Marca los tipos que recomiendes para este tipo de proyecto.
- Los documentos presentes no se reescriben. El usuario puede elegir "revisar" para uno fino.
- El usuario selecciona. No escribas un tipo que el usuario no haya seleccionado.
3. Construye la ficha técnica
Antes de que alguien escriba, recopila los hechos que usarán más de un documento. Tómalos del código y de git, no de la memoria. Escríbelos en un archivo temporal.
| Hecho | Fuente |
|---|---|
| Nombre del proyecto y propósito en una frase | README, manifiesto, el usuario |
| Versión actual | manifiesto, último tag (git describe --tags --abbrev=0) |
| Lenguajes, frameworks y sus versiones | manifiestos y archivos de bloqueo |
| Comandos de instalación, prueba, lint, compilación y ejecución | engineering:development-commands |
| Componentes y sus nombres | estructura de directorios, puntos de entrada, archivos compose |
| Variables de entorno y configuraciones | .env.example, y el código que lee configuraciones (busca process.env, os.environ, getenv) |
| Fechas importantes | el primer commit (git log --reverse), los tags |
| Lo que funciona hoy, lo que no | el usuario, issues abiertos |
Si dos fuentes discrepan, pregunta al usuario. No elijas una en silencio. Cada escritor utiliza solo la ficha técnica y el código.
4. Escribe
- Tres documentos o menos: escríbelos tú mismo, uno tras otro.
- Más de tres: inicia un subagente para cada documento o grupo pequeño, como máximo cuatro a la vez. Dale a cada subagente:
- el archivo o archivos exactos que le pertenecen, y la regla de que no puede cambiar ningún otro archivo;
- la ficha técnica;
- el esquema de secciones para su tipo de
resources/doc-catalog.md; - la instrucción de escribir en Inglés Técnico Simplificado (la skill
simple-english, si está instalada); - la instrucción de informar los hechos que necesitó y no encontró, en lugar de inventarlos.
No inventes historia, números, usuarios o características. Escribe "TBD" y enuméralo para el usuario.
5. Verifica el conjunto
Sigue resources/consistency-check.md. Corrige cualquier problema antes de continuar.
6. Commit
Coloca los documentos en una rama (engineering:git-branching) y abre un PR (engineering:github-pr-merge). En el cuerpo del PR, enumera cada nuevo documento y cada "TBD" que necesite una respuesta del usuario.
Skills relacionadas
engineering:documentation-sync: mantiene estos documentos correctos después de esto.gener8v:brownfield: incorpora una base de código existente a la pipeline gener8v. Escribe contexto.gener8v/, no estos documentos de proyecto.