How fokerman/computingsystemscourse works
Este repositorio es el contenido de un curso de Sistemas de Computadoras y está orientado a la generación de presentaciones y materiales de clase mediante LaTeX e Inkscape. El repositorio se organiza en dos grandes variantes (o “sabores”) del curso: InOrder y ReverseOrder, cada uno con su propia estructura modular de temas o clases, distribuidas en carpetas individuales.
A continuación se ofrece una guía de alto nivel para armar un diagrama de la arquitectura del sistema, enfocado en la estructura modular y el proceso de compilación/deployment:
Identificar los principales componentes
• Repositorio Raíz: Contiene archivos globales (como .gitignore, LICENSE, Makefiles generales, university.tex, packages.sty) y directorios compartidos (por ejemplo, la carpeta “other” y “common”) que se usan para configuraciones y recursos comunes.
• Versiones del curso:
• Versión InOrder: Carpeta “version_InOrder” que incluye múltiples subdirectorios (por ejemplo, T01_..., T02_..., T03_..., etc.) donde cada uno representa una clase o tema – cada módulo suele contener un Makefile, un archivo “clase.tex”, y recursos gráficos en la carpeta “img” (además de fuentes adicionales en “src” para algunos temas).
• Versión ReverseOrder: Similar a InOrder, pero con una organización distinta de temas (iniciando en programación en C y luego cubriendo temas de sistemas operativos, hardware, etc.), cada módulo con su propia estructura de Makefile, clase.tex, imágenes, y en ocasiones código fuente.
• Herramientas y dependencias externas:
• LaTeX: Usado para compilar las presentaciones y los documentos generados.
• Inkscape: Utilizado para generar y compilar los gráficos (en formatos SVG o convertidos) a formatos compatibles para inclusión en las presentaciones.
• Flujos de compilación:
• Makefiles: Ejecutan toda la cadena de generación de presentaciones y gráficos en cada módulo. Existen Makefiles específicos de cada clase y también unos generales en la raíz o dentro de “other” y “common”.
Determinar las relaciones e interacciones
• Cada módulo o tema se puede visualizar como un bloque independiente que depende de un flujo de compilación basado en Makefiles. Estos bloques comparten recursos comunes (por ejemplo, configuraciones definidas en “common”) y siguen un proceso similar (lectura de fichero LaTeX, compilación de imágenes mediante Inkscape, ensamblado final de la presentación).
• La relación entre “version_InOrder” y “version_ReverseOrder” se representa en el diagrama como ramas paralelas que comparten algunos archivos comunes y plantillas generales (como university.tex y packages.sty).
• La interacción entre los componentes del proceso reside en la secuencia: Código fuente (archivos .tex y SVG) → Procesos de compilación (Makefiles, ejecución de comandos LaTeX e Inkscape) → Resultados (presentaciones, PDFs).
Principales patrones y principios de diseño
• Modularidad: Cada apartado del curso (cada TXX) es un módulo autocontenible, lo que permite actualizar o compilar independientemente.
• Reutilización y separación de intereses: Los recursos comunes se gestionan en carpetas “common” y “other”, y se centraliza la configuración y construcción a través de Makefiles.
• Dependencia clara de herramientas externas: El diagrama debe reflejar la dependencia del flujo de trabajo en herramientas de terceros (LaTeX e Inkscape).
Tecnologías y frameworks relevantes
• LaTeX para la generación de documentos.
• Inkscape para el procesamiento y conversión de gráficos vectoriales.
• Makefiles como herramienta de automatización para compilar y unir componentes.
Instrucciones para estructurar el diagrama
a. Componentes principales en forma de bloques:
• Bloque Raíz/Configuración: Representar archivos globales y recursos comunes (p.ej., university.tex, packages.sty, “other” y “common”).
• Bloque Version InOrder: Agrupar todos los submódulos temáticos (cada T01, T02, ... T22) en esta rama.
• Bloque Version ReverseOrder: Agrupar sus respectivos módulos temáticos.
• Bloque de Herramientas Externas: Incluir LaTeX y Inkscape como “servicios” de compilación.
b. Flechas direccionales:
• Dibujar flechas que indiquen el flujo de información desde los archivos fuente (archivos .tex, SVG, código de ejemplo) hacia el sistema de compilación.
• Mostrar dependencias: Por ejemplo, desde cada módulo hacia la herramienta de compilación (Makefiles) y luego el proceso que envía resultados a PDF o presentaciones.
c. Elementos visuales:
• Utilizar colores o formas diferentes para distinguir entre:
• Módulos de contenidos (cada tema/clase).
• Recursos/archivos comunes.
• Herramientas de procesamiento (LaTeX, Inkscape).
• Flujo de compilación/automatización (Makefiles).
d. Etiquetas y anotaciones:
• Incluir etiquetas claras para cada bloque y subcomponente.
• Agregar notas que expliquen la secuencia del proceso (por ejemplo, “Compilación de imágenes” o “Generación de presentación via LaTeX”) para resaltar la funcionalidad.
Consideraciones específicas para este proyecto
• Dado que el proyecto no es una aplicación de servicio o full-stack, sino una colección modular de clases y presentaciones, el diagrama se focaliza en mostrar la relación entre módulos de contenido (por temas) y el proceso de construcción automatizado de dichos módulos.
• Se debe resaltar la existencia de dos “sabores” del curso (InOrder y ReverseOrder) para facilitar la comprensión de que se ofrecen rutas alternativas de estudio.
• Los Makefiles y el flujo de compilación son críticos, por lo que es aconsejable incluir un sub-diagrama o sección específica en el sistema que detalle este proceso.
En resumen, el diagrama de arquitectura debe plasmar la organización modular del repositorio (dividido en versiones InOrder y ReverseOrder con subtemas individuales), el proceso de compilación mediante Makefiles y la integración de herramientas externas (LaTeX e Inkscape). Se debe destacar las dependencias y el flujo de datos desde los archivos fuente hasta el resultado final de las presentaciones, utilizando etiquetas claras, direccionalidad y codificación de colores para diferenciar cada tipo de componente.
Esta visión detallada permitirá al ingeniero principal comprender y documentar con precisión la estructura y el flujo de trabajo del repositorio, facilitando futuras mejoras o mantenimientos en el sistema.