📋 Plan de Documentación / Documentation Plan

ES: Registro maestro para el seguimiento de la documentación en todo el monorepo. Este archivo es la fuente única de verdad sobre qué documentación existe, en qué estado se encuentra y qué pasos siguen. Este documento realiza seguimiento únicamente de la documentación, no del código ni de las pruebas —estos últimos se gestionan en el roadmap y en el ciclo de sprint de cada rama—.

EN: Master tracking for documentation work across the monorepo. This file is the single source of truth for what docs exist, what state they are in, and what is next. It tracks documentation only, not code or tests —those live in the roadmap and the sprint cycle of each branch—.


🧭 Leyenda / Legend

Símbolo / Symbol Significado / Meaning
✅ Completo / Complete
🔄 En progreso / In progress
📋 Planificado / Planned
⏳ Futuro (no iniciado) / Future (not started)
❌ No aplica a este lenguaje / Does not apply to this language

1. Documentos transversales / Cross-cutting documents (all 50 languages)

Documento / Document Propósito / Purpose Estado / State Responsable / Owner
docs/ruleset/PSEUDOCODE_CONVENTION.md Pseudocódigo canónico, nombres conceptuales y casos medidos / Canonical pseudocode, conceptual names, measured cases ✅ Software Architect (apoyo: Language-Specific SME)
docs/ruleset/LANGUAGE_CHARACTERISTICS.md 11 ejes por lenguaje / 11 axes per language ✅ Language-Specific SME
docs/ruleset/IDIOMATICITY_LEVELS.md Escala de 4 niveles con 9 ejes de evaluación / 4-level scale with 9 evaluation axes ✅ Software Architect (apoyo: SDET)
docs/ruleset/DEVIATION_POLICY.md Política de registro de desviaciones / When/how to document deviations ✅ Software Architect
docs/ruleset/PARADIGM_FAMILIES.md 9 familias prácticas y pseudocódigo ajustado por familia / 9 practical families and per-family adjusted pseudocode ✅ Software Architect (apoyo: Language-Specific SME)
docs/ruleset/Idioms_Template.md Plantilla de docs/ruleset/idioms/{lang}.md (ficha rápida, nombres, construcción, desviaciones) / Template for idioms/{lang}.md ✅ Documentation Architect (contenido: Language-Specific SME)
docs/ruleset/data/canonical_names.tsv Mapeo concepto → nombre canónico por lenguaje / concept → name per language ✅ Language-Specific SME
docs/ruleset/data/language_characteristics.tsv Ejes estructurados legibles por máquina / Machine-readable axes ✅ Language-Specific SME
docs/ruleset/data/idiomaticity_state.tsv Estado por (lenguaje, módulo): 2 ejes principales (objetivo idiomático y fidelidad al módulo) / State per (lang, module): 2 principal axes 🔄 SDET

2. Documentos por lenguaje / Per-language documents

ES: No se generan 50 ficheros. Los datos del lenguaje (nombres, ejes, toolchain, palabras reservadas) son los TSV de data/; el cómo compartido es PARADIGM_FAMILIES.md (9 familias). docs/ruleset/idioms/{lang}.md es a demanda: se crea con Idioms_Template.md solo cuando ese lenguaje tenga algo que no quepa en su familia ni en el TSV (filosofía, trampas, causa de sus desviaciones). No hay adaptations/{lang}.md: la desviación concreta se justifica en el README del módulo, con el formato de DEVIATION_POLICY.md. No hay changelog por lenguaje: la historia la lleva git y el estado idiomaticity_state.tsv. Responsable si se crea: Language-Specific SME (apoyo: Technical Writer); la plantilla es del Documentation Architect. Pendiente: un piloto con assembly (y opcionalmente cobol) para decidir el recorte de las secciones 5–8 de la plantilla.

EN: No 50 files are generated. The language facts (names, axes, toolchain, reserved words) are the TSVs under data/; the shared how is PARADIGM_FAMILIES.md (9 families). docs/ruleset/idioms/{lang}.md is on demand: created from Idioms_Template.md only when that language has something that fits neither its family nor the TSV (philosophy, pitfalls, cause of its deviations). There is no adaptations/{lang}.md: the concrete deviation is justified in the module README, using the DEVIATION_POLICY.md format. There is no per-language changelog: history lives in git and state in idiomaticity_state.tsv. Owner if created: Language-Specific SME (support: Technical Writer); the template belongs to the Documentation Architect. Pending: a pilot with assembly (and optionally cobol) to decide the trim of the template’s sections 5–8.


3. Documentos por módulo / Per-module documents

ES: Pendiente registrado (revisión posterior): alinear los README de módulo ({lenguaje}/core/{fase}/{módulo}/README.md) con PARADIGM_FAMILIES.md — manteniendo su pseudocódigo canónico y su didáctica y añadiendo el enlace a la familia — y revisar el impacto en docs/ROADMAP.md y docs/ROADMAP_UPDATE_CHECKLIST.md. Nada de eso se ha modificado en este cambio.

EN: Registered pending item (later review): align module READMEs ({lang}/core/{phase}/{module}/README.md) with PARADIGM_FAMILIES.md — keeping their canonical pseudocode and teaching material and adding the family link — and review the impact on docs/ROADMAP.md and docs/ROADMAP_UPDATE_CHECKLIST.md. None of that has been modified in this change.

Fase / Phase Módulo / Module Especificación / Spec README (N3) Evidencia / Evidence Estado / State Responsable / Owner
Fase 0 — Foundations core.foundations.hello_world ✅ ✅ 📋 ✅ —
Fase 0 — Foundations core.foundations.hello_user ✅ ✅ 📋 ✅ —
Fase 0 — Foundations core.foundations.unit_test ✅ ✅ 📋 ✅ —
Fase 0 — Foundations core.foundations.numbers ✅ ✅ 📋 ✅ —
Fase 1 — Algorithms Pure core.algorithms.naive_sort ✅ ✅ ✅ ✅ —
Fase 1 — Algorithms Pure core.algorithms.data_structures_basics ✅ ✅ ✅ ✅ Software Architect (apoyo: Language-Specific SME, SDET)
Fase 1 — Algorithms Pure core.algorithms.data_structures_advanced ✅ 📋 📋 📋 —
Fase 1 — Algorithms Pure core.algorithms.efficient_sort ✅ 📋 📋 📋 —
Fase 1 — Algorithms Pure core.algorithms.distributed_sort ✅ 📋 📋 📋 —
Fase 1 — Algorithms Pure core.algorithms.searching ✅ 📋 📋 📋 —
Fase 2 — Contiguous Processing core.text.transformations ✅ 📋 📋 🔄 —
Fase 2 — Contiguous Processing core.text.patterns ✅ 📋 📋 📋 —
Fase 2 — Contiguous Processing core.text.substr ✅ 📋 📋 📋 —
Fase 2 — Contiguous Processing core.text.input_output ✅ 📋 📋 📋 —
Fase 2 — Contiguous Processing core.text.etl_basico ✅ 📋 📋 📋 —
Fase 3 — Algorithms on Structures core.structures.graph_algorithms ✅ 📋 📋 📋 —
Fase 3 — Algorithms on Structures core.structures.backtracking ✅ 📋 📋 📋 —
Fase 3 — Algorithms on Structures core.structures.dynamic_programming ✅ 📋 📋 📋 —
Fase 3 — Algorithms on Structures core.structures.greedy ✅ 📋 📋 📋 —
Fase 4 — Abstraction & Persistence core.data.modeling 📋 📋 📋 📋 —
Fase 4 — Abstraction & Persistence core.data.strsearch 📋 📋 📋 📋 —
Fase 4 — Abstraction & Persistence core.data.regex 📋 📋 📋 📋 —
Fase 4 — Abstraction & Persistence core.data.parsing 📋 📋 📋 📋 —
Fase 4 — Abstraction & Persistence core.data.data_base 📋 📋 📋 📋 —
Fase 4 — Abstraction & Persistence core.data.integracion_etl 📋 📋 📋 📋 —
Fase 5 — Math core.math.statistics 📋 📋 📋 📋 —
Fase 5 — Math core.math.linear_algebra 📋 📋 📋 📋 —
Utilidades / Utilities util.logging ⏳ ⏳ ⏳ ⏳ —
Utilidades / Utilities util.db ⏳ ⏳ ⏳ ⏳ —
Utilidades / Utilities util.data_transform ⏳ ⏳ ⏳ ⏳ —
Utilidades / Utilities util.serialization ⏳ ⏳ ⏳ ⏳ —
Utilidades / Utilities util.config ⏳ ⏳ ⏳ ⏳ —
Herramientas / Dev Tools tools.sast_ada ⏳ ⏳ ⏳ ⏳ —
Herramientas / Dev Tools tools.coverage_reporter ⏳ ⏳ ⏳ ⏳ —
Herramientas / Dev Tools tools.linter_aggregator ⏳ ⏳ ⏳ ⏳ —
Fase 6 — UI ui.cliapp ⏳ ⏳ ⏳ ⏳ —
Fase 6 — UI ui.tuiapp ⏳ ⏳ ⏳ ⏳ —
Fase 6 — UI ui.guiapp ⏳ ⏳ ⏳ ⏳ —
Fase 7 — Web web.mvcapp ⏳ ⏳ ⏳ ⏳ —
Fase 7 — Web web.api ⏳ ⏳ ⏳ ⏳ —
Fase 8 — Async async.futures_and_promises ⏳ ⏳ ⏳ ⏳ —
Fase 8 — Async async.async_await ⏳ ⏳ ⏳ ⏳ —
Fase 8 — Async async.actor_model ⏳ ⏳ ⏳ ⏳ —
Fase 8 — Async async.channels ⏳ ⏳ ⏳ ⏳ —
Fase 8 — Async async.parallel ⏳ ⏳ ⏳ ⏳ —
Fase 9 — Interop interop.c_binding ⏳ ⏳ ⏳ ⏳ —
Fase 9 — Interop interop.system_calls ⏳ ⏳ ⏳ ⏳ —
Fase 9 — Interop interop.other_lang_bridge ⏳ ⏳ ⏳ ⏳ —

4. Documentos de tooling / Tooling documents (glot, sprint, roadmap, agent template)

Documento / Document Propósito / Purpose Estado / State Responsable / Owner
docs/ROADMAP.md Progreso por fases, especificaciones y contadores X/50 / Phase progress, specs, and X/50 counters 🔄 —
docs/WORKFLOW.md Norma del ciclo, realizable manualmente / Tool-independent cycle policy ✅ —
scripts/README.md (glot CLI docs, referencia / reference) Herramienta personal del autor; documentación separada del contenido académico / Author’s personal helper; documentation separate from academic content ✅ —
docs/AGENT_Template.md / AGENTS.md Contrato de agentes de IA, roles y calendario de adopción / AI agent contract, roles, and adoption schedule ✅ —
docs/ROADMAP_UPDATE_CHECKLIST.md Lista de verificación obligatoria para cierre de fase y módulo / Verification checklist for phase and module closure ✅ —
docs/README_Template.md Plantilla canónica de README de Nivel 3 para módulos / Canonical Level 3 module README template ✅ —

5. Orden de trabajo / Order of work

Cadena bloqueante / Blocking chain (must exist before auditing begins)

  1. docs/ruleset/PSEUDOCODE_CONVENTION.md → hecho / done ✅
  2. docs/ruleset/IDIOMATICITY_LEVELS.md → hecho / done ✅
  3. docs/ruleset/data/canonical_names.tsv → hecho / done ✅
  4. docs/ruleset/LANGUAGE_CHARACTERISTICS.md → hecho / done ✅
  5. docs/ruleset/data/language_characteristics.tsv → hecho / done ✅

Cadena de soporte / Support chain (can be done in parallel)

  1. docs/ruleset/DEVIATION_POLICY.md → hecho / done ✅
  2. docs/ruleset/PARADIGM_FAMILIES.md → hecho / done ✅
  3. docs/ruleset/data/idiomaticity_state.tsv → en curso / in progress 🔄
  4. Plantilla lista: docs/ruleset/Idioms_Template.md → hecho / done ✅ · archivos por lenguaje en docs/ruleset/idioms/{lang}.md / Per-language idioms/ files
  5. docs/ruleset/adaptations/{lang}.md → no se crean / not created: la desviación concreta se justifica en el README del módulo / the concrete deviation is justified in the module README
  6. Changelogs por lenguaje / Per-language changelogs