docs-system — v1.0.0
Instala y mantiene un sistema completo de documentación en cualquier repositorio. Usa este skill cuando un proyecto necesite sus documentos organizados, clasificados, indexados y sincronizados — o cuando se te pida "configurar el sistema de documentación / taxonomía de documentos / compendios de documentación".
El skill se implementa mediante cuatro scripts (en scripts/); se invocan en orden. Todos son idempotentes y preservan el historial (git mv); la migración está controlada por revisión (--dry-run primero).
Cuándo usar
- Un repositorio tiene documentos sueltos y sin clasificar → instalar el sistema y migrarlos.
- Se creó o editó un documento → regenerar el compendio de esa carpeta (paso obligatorio).
- Alguien solicita un índice de documentos / glosario / "memorial" / taxonomía.
Comandos (scripts)
| Comando | Script | Propósito |
|---|---|---|
| bootstrap | scripts/docs-bootstrap.sh <repo> | Instalar el kit: crear carpetas de categorías, copiar documentos de gobierno (taxonomía/plantillas/guía rápida/registro/glosario), instalar los 4 scripts, agregar la regla de documentación al archivo del agente. Idempotente. |
| migrate | `scripts/docs-migrate.sh [--dry-run | --apply] ` |
| compile | scripts/docs-compile.sh <carpeta> | (Re)construir <carpeta>/MEMORIAL.md — un compendio ordenado por fecha de cada documento con índice + enlace al glosario + cuerpos completos. Reconstrucción determinista: idempotente / auto-adición / deduplicación / reordenación. --clean <carpeta> lo elimina. |
| append | scripts/docs-append.sh <doc> ["resumen"] | Añadir una línea de enlace para un documento a su carpeta README.md índice (idempotente). |
Flujo de trabajo estándar
# 1. configurar (una vez por repositorio)
cp docs-system.conf.example .docs-system.conf # editar PROJECT_NAME, AGENT_RULES, PLAN_BUCKET
# 2. instalar
scripts/docs-bootstrap.sh .
# 3. migrar documentos existentes — PRUEBA EN SECO PRIMERO, revisar, luego aplicar
scripts/docs-migrate.sh --dry-run .
scripts/docs-migrate.sh --apply .
# 4. construir compendios
for d in documentation features testing reviews changes PLANS; do
scripts/docs-compile.sh "docs/$d"
done
# 5. finalizar: resembrar docs/documentation/DOCUMENTATION-REGISTRY.md, editar GLOSSARY.md términos del proyecto
REGLA OBLIGATORIA continua
Después de crear o editar CUALQUIER documento en docs/<carpeta>/, ejecuta
scripts/docs-compile.sh docs/<carpeta> y confirma el MEMORIAL.md regenerado junto con el documento.
No edites MEMORIAL.md manualmente (es generado). Esta regla también se escribe en el archivo de reglas del agente del repositorio destino durante bootstrap.
Marcadores de encabezado de documento (obligatorios)
Cada .md lleva, debajo de su H1:
<!-- version --> · <!-- classification: TIPO --> · <!-- date --> · <!-- last-updated -->.
date se establece una vez (creación); solo last-updated cambia en ediciones. Tipos:
FEATURE / TESTING / DESIGN / GAPS / ANALYSIS / CHANGE / STUDY / REVIEW / ARCHITECTURE / SUMMARY / PLAN.
Seguridad / reversión
docs-migrate.shpor defecto usa--dry-run; revisa la tabla antes de--apply.- Revertir compendios:
scripts/docs-compile.sh --clean docs/<carpeta>ofind docs -name MEMORIAL.md -delete. - Todo está en git;
git revertdeshace una ejecución. Los movimientos son renombrados (historial preservado).
Referencias
references/PLAYBOOK.md— procedimiento completo, opciones de configuración, verificación, reversión.