Saltar a contenido

Axiomas editoriales: claridad y autonomía del método

Estos axiomas rigen la redacción de esta revisión. Son reglas editoriales; no añaden requisitos a ASILO 0.1, MILPA 0.1 ni SCAFFOLD 0.1. Una explicación y una regla aceptada tienen distinta autoridad.

DOC-AX-001 — Voz accesible, neutral y precisa

La documentación DEBE usar una voz accesible y neutral, conservar el profesionalismo y definir los términos técnicos necesarios. Cada instrucción identifica quién actúa, qué hace, sobre qué objeto y bajo qué condición. El lenguaje claro facilita comparar traducciones y reduce ambigüedad; no garantiza por sí solo equivalencia entre idiomas.

  • Presentar primero el propósito, después un ejemplo y finalmente el detalle técnico.
  • Usar una palabra estable por concepto. Explicar una sigla en su primera aparición; desarrollarla sólo si una fuente identificada establece su expansión.
  • Evitar modismos, humor local, metáforas sin explicación, juicios sobre personas y promesas absolutas.
  • Conservar IDs, unidades, cifras, negaciones, excepciones y fuerza normativa al traducir.
  • Mantener términos necesarios como autorización, capacidad, contrato o riesgo residual. Explicarlos en el glosario, sin sustituirlos por palabras menos precisas.
  • Nombrar una discrepancia y revisarla. La traducción es informativa mientras no tenga otra autoridad declarada.
Redacción ambigua Redacción verificable
«El sistema lo controla todo». «El control comprueba el permiso antes de escribir el archivo».
«El responsable debe aprobarlo». «La persona responsable aprueba el borrado de los registros indicados antes de ejecutarlo».
«Este anillo es seguro». «Esta capa no importa adaptadores externos; la comprobación de dependencias revisa esa regla».

El segundo ejemplo es una explicación. Si expresa una obligación normativa, se cita el requisito aplicable y se conservan su condición y excepción.

DOC-AX-002 — Método agnóstico y autosuficiente

La documentación pública DEBE explicar el método sin depender de una organización, producto, repositorio privado, proveedor, lenguaje o uso interno. Los ejemplos son ficticios y portables. La autoría y la licencia se conservan; atribuir una obra no obliga a adoptar su ecosistema.

  • El método explica propósito, conceptos, reglas y límites.
  • Un perfil declara las decisiones concretas de su contexto y su propio estado.
  • Una implementación explica instalación, API, operación, pruebas y versión en su documentación.
  • Los inventarios de productos, diagnósticos de paquetes, rutas locales y decisiones privadas quedan fuera del recorrido público y de sus diagramas, descargas y traducciones.
  • La selección de páginas del sitio no establece permisos sobre un repositorio o su historial.

Analogías y diagramas

Cada analogía dice qué ayuda a entender y dónde deja de servir. Cada diagrama tiene una explicación en texto: una persona puede comprender el proceso sin verlo. Las flechas indican dependencia, secuencia o transferencia según su leyenda; no demuestran controles implementados.

Revisión de traducciones

flowchart LR
  accTitle: Revisión de traducciones
  accDescr: Secuencia de izquierda a derecha: del texto original con actor, acción y condición se consultan términos e IDs estables, se traduce sin alterar obligación ni excepción, se comparan negaciones, cifras, alcance y límites, y se hace revisión lingüística y de dominio. El resultado es una versión identificada o una discrepancia registrada.
  O["Texto original: actor, acción y condición"] --> G["Consultar términos e IDs estables"]
  G --> T["Traducir sin alterar obligación ni excepción"]
  T --> C["Comparar negaciones, cifras, alcance y límites"]
  C --> R["Revisión lingüística y de dominio"]
  R --> V["Versión identificada o discrepancia registrada"]

Diagrama SVG: Revisión de traducciones · Fuente editable Mermaid.

La revisión compara la traducción con la versión original y registra diferencias materiales. No cambia un término aceptado sólo para que suene más natural. Cuando no existe equivalencia directa, conserva el término de origen y añade una definición.

DOC-AX-003 — Español primero y traducción trazable

Los axiomas, conceptos, ejemplos y decisiones se redactan y revisan primero en español. Cada traducción parte de una revisión identificada del original y conserva IDs, cifras, negaciones, condiciones, excepciones y fuerza normativa. Un cambio de significado vuelve a la fuente española para decisión y después se propaga a las traducciones.

Las siglas ASILO, MILPA y SCAFFOLD se escriben en mayúsculas. Las rutas técnicas conservan su convención en minúsculas. La expansión de una sigla requiere una fuente identificada.

DOC-AX-004 — Utilidad técnica y comunicación verificable

Cada entrada explica el problema, quién necesita resolverlo, el primer paso, los registros que produce y cómo comprobar el resultado. Sus ejemplos usan datos ficticios. Las afirmaciones de adopción, ahorro, seguridad o cumplimiento requieren evidencia fechada. Los títulos y descripciones presentan el contenido real de la página, con términos estables.

DOC-AX-005 — Analogías explicadas y apellidos descriptivos

Cada metodología DEBE presentarse en su entrada con la sigla y un apellido descriptivo que indique su propósito. El apellido no desarrolla la sigla ni cambia el alcance de la edición.

Sigla Apellido descriptivo
ASILO Límites y seguridad de sistemas construidos con IA. «Con IA» significa aquí con asistencia de inteligencia artificial.
MILPA Conocimiento y procedencia.
SCAFFOLD Proyectos de software con personas y asistentes de IA.

Cada analogía DEBE explicar su referente, los términos necesarios, el concepto que ayuda a comprender, las correspondencias elegidas y dónde deja de servir. Las correspondencias editoriales se identifican como tales: no crean requisitos, clases de agentes ni permisos. Las afirmaciones sobre el referente cultural o científico se apoyan en fuentes identificadas.

Cada diagrama DEBE tener título, leyenda para sus flechas y una explicación textual equivalente. Cuando se ofrece un SVG junto a Mermaid, ambos conservan términos, relaciones y límites; la fuente editable, el recurso y su procedencia se registran. El color nunca es la única señal. Una ilustración no prueba controles ni resultados. Redactar primero en español y después traducir.

Un término técnico se define al primer uso o se enlaza a una definición. Se distingue método, perfil, implementación y ejemplo. La milpa muestra cómo aplicar este axioma; el recorrido visual reúne los diagramas.

El mapa común identifica los referentes principales: refugio para ASILO, policultivo para MILPA y andamio para SCAFFOLD. ASILO conserva su nombre y explica en las traducciones que toma del español «asilo» la idea de refugio o protección. Las imágenes auxiliares explican una decisión concreta sin cambiar ese referente principal.

DOC-AX-006 — Alcance de IA y condiciones explícitas

La documentación DEBE distinguir IA, interacción con un modelo, asistencia y coordinación multiagente. ASILO trata sistemas construidos con asistencia de IA y los usos pertinentes de modelos; SCAFFOLD trata proyectos de software construidos con IA, con uno o varios asistentes. Ninguno exige varios agentes como condición general. Cada requisito conserva su alcance, condición, excepción y fuerza aceptados. Los fallos entre agentes se evalúan cuando hay más de uno.

Arquitectura y seguridad se explican dentro de ASILO. Los modelos de anillos son ilustrativos; las implementaciones de software se identifican en la frontera con el software.