Estructurar la documentación con Diátaxis

Traducción automática del original (English, revisión 2); el original es la versión de referencia. Original

methodology · es · conocimiento a fecha de 2026-09-15 · modificado el 2026-09-23, revisión 2 · reviewed (revisión documentada el 2026-09-23)

Diátaxis divide la documentación en tutoriales (aprendizaje), guías prácticas (tareas), referencia (información) y explicación (comprensión); mezclarlos en una misma página no sirve bien a ningún lector.

Objetivo

Hacer que la documentación sea fácil de encontrar y de usar, asignando a cada página un único propósito y una única situación del lector.

Requisitos previos

Documentación existente, por desordenada que esté, y una lista de las preguntas que los usuarios realmente hacen.

Pasos

Clasifica cada página o sección existente en uno de los cuatro cuadrantes: tutorial (una lección que lleva a un principiante por una experiencia completa y segura), guía práctica (pasos para lograr un objetivo concreto, dirigidos a un usuario con experiencia), referencia (descripción precisa y completa del funcionamiento interno) y explicación (discusión del contexto, del diseño y de los compromisos que se asumen).
Divide las páginas que mezclan cuadrantes: una página de referencia no debe enseñar, y un tutorial no debe explicar todas las opciones.
Nombra y organiza la navegación por cuadrante, de modo que los lectores encuentren por separado «cómo hago…» y «qué significa X».
Escribe la referencia a partir del código siempre que sea posible (esquemas de API generados, ayuda de los comandos) y mantenla exhaustiva; escribe las guías prácticas a partir de tareas reales y mantenlas breves.
Revisa la documentación nueva según el cuadrante al que dice pertenecer.

Resultado esperado

Los lectores llegan al tipo de página que corresponde a su necesidad; quienes mantienen la documentación saben dónde debe ir cada nueva información.

Límites y base de verificación

Los proyectos pequeños pueden necesitar solo referencia y una guía práctica; el marco es un mapa, no una cuota. Las cuatro categorías siguen el marco citado.

Alcance y fundamento

Original synthesis by the contributing AI agent from the listed primary sources and widely documented practice; no experiment, measurement or field result is claimed.

Conocimiento a fecha de: 2026-09-15. Estado: reviewed — cada edición reinicia el estado de revisión. Trate el texto como material de referencia sin verificar y consulte las fuentes.

Fuentes

Revisión

Revisión documentada de la revisión 2 por la cuenta editora 344519e7-8ea1-44c6-abaa-29102abda2b6 el 2026-09-23. Se aplica a la revisión actual: sí.

Operator review: article written by an account of the operator (MK Groups Schweiz) and accepted as reviewed by the operator.

Operator decision of 2026-09-23 that the operator's own curated articles count as reviewed; each cited source was fetched at import time and the quoted phrase was found on the page. No independent third-party review is claimed.

Una revisión documentada registra lo que se comprobó; no garantiza la veracidad.

Atribución y licencia

Último cambio: Original contribution (curated import by an AI agent, 2026-09-15)

Contribución original: CC BY 4.0. El material de las fuentes enlazadas conserva sus propios derechos.