Documentación
Esta sección reúne todo lo que necesitas para entender, utilizar y operar este proyecto.
La documentación está organizada para atender diferentes momentos de uso: desde el primer contacto hasta la operación y evolución del sistema. En lugar de concentrar toda la información en un único formato, el contenido fue dividido en tipos distintos, cada uno con un propósito claro.
Esta organización sigue el modelo Diátaxis, que separa la documentación según la necesidad de quien la consulta.
Cómo navegar
En el menú vertical de la izquierda o al final de esta página, la documentación está organizada por tecnologías estudiadas a lo largo del proyecto. Cada tecnología fue estructurada en cuatro secciones principales:
Tutoriales
Los Tutoriales están diseñados para la etapa inicial de contacto con una tecnología. Su objetivo principal es el aprendizaje práctico, guiando a las personas por un flujo continuo hasta que logren un resultado funcional. En esta sección, el enfoque no es la teoría exhaustiva, sino permitir que quien consulta aprenda ejecutando, estableciendo una base sólida sobre cómo los componentes del sistema se integran en la práctica.
Guías How-To
A diferencia de los tutoriales, las guías de tareas (how-to guides), que en esta documentación se identifican como Guías How-To, parten del supuesto de que quien accede al contenido ya tiene conocimientos básicos y busca alcanzar un objetivo o resolver un problema puntual. Son instrucciones objetivas y procedimentales orientadas a la ejecución de tareas específicas, y funcionan como un recurso de consulta directa para personas que ya saben lo que necesitan realizar y buscan orientación técnica para completar la acción de manera eficiente.
Referencias
La sección de Referencias constituye el inventario técnico del sistema. Ofrece una descripción de parámetros, configuraciones, comportamientos y especificaciones. Es contenido de naturaleza informativa y estática, esencial cuando se necesitan datos precisos y hechos técnicos exactos para fundamentar la operación o el desarrollo.
Explainers
Mientras las secciones anteriores se enfocan en la ejecución, los Explainers se dedican a entender el “por qué”. Este contenido profundiza en conceptos, decisiones de diseño y el funcionamiento lógico. Su objetivo es ofrecer el contexto detrás de las decisiones técnicas del proyecto, permitiendo comprender la arquitectura de forma amplia y fundamentada.
Cómo usar esta documentación
Cada tipo de contenido responde a una necesidad diferente. En lugar de leer todo en secuencia, lo adecuado es acceder a la sección que corresponde a tu momento de uso:
- Si estás empezando: ve a Tutoriales
- Si necesitas realizar algo específico: ve a Guías How-To
- Si necesitas detalles técnicos: consulta la Referencia
- Si quieres entender mejor el sistema: lee las Explainers