Skip to main content
This guide establishes the formatting standards for creating educational materials in the ASIR-ISO course. Following these conventions ensures consistency across all didactic units and facilitates uploading materials to the Moodle platform.

​
Task Formatting

All tasks (Tareas) must follow a standardized format to maintain consistency and enable proper processing for PDF generation and Moodle integration.

​
Required Structure

Every task file must adhere to this template: 
# Tarea: Nombre de la Tarea

## Ejercicio 1
## Ejercicio 2
## Ejercicio ...
## Ejercicio N
1
Start with the Task Title
2
Begin every task file with a level-1 heading that includes the word “Tarea” followed by the task name:
3
# Tarea: [Task Name]
4
Add Individual Exercises
5
Each exercise within the task should be a level-2 heading with sequential numbering:
6
## Ejercicio 1
## Ejercicio 2
## Ejercicio 3
7
Include Exercise Content
8
Below each exercise heading, add the instructions, questions, or activities for students to complete.

​
File Naming Conventions

Consistent file naming is critical for the automated build system to process materials correctly.

​
Task Files

Task files must follow this naming pattern: 
Tarea_[NUMBER]_[NAME].md
Examples:
  • Tarea_02_TiposDeAplicaciones.md
  • Tarea_05_SistemasOperativos.md
  • Tarea_20_Licencias.md
The build script parses task filenames to extract the number and name. Deviating from this pattern will cause the PDF generation to fail.

​
Theory Files

Theory materials should be named: 
Teoria_[NUMBER]_[NAME].md
Examples:
  • Teoria_00_Introduccion.md
  • Teoria_01_ArquitecturaSistemaInformatico.md
  • Teoria_02_SoftwareAplicaciones.md

​
Annex Files

Supplementary materials use the annex prefix: 
Anexo_[NUMBER]_[NAME].md

​
Front Matter

All task files should include YAML front matter with metadata: 
---
title: UD01 - Introducción a los Sistemas Operativos
author: Angel Berlanas Vicente
header-includes: |
lang: es-ES
keywords: [ASIR, ISO, Arquitectura de un Sistema Informático, licencias]
---
  • title: The didactic unit and topic name
  • author: Creator of the material
  • lang: Language code (es-ES for Spanish)
  • keywords: Array of relevant keywords for indexing
  • header-includes: Additional LaTeX commands (optional)

​
Content Guidelines

​
Markdown Formatting

Use standard Markdown syntax for content:
  • Tables for structured data
  • Lists for sequential or grouped items
  • Links for external resources
  • Code blocks for command examples
  • Bold/Italic for emphasis

​
Language

All materials are written in Spanish (es-ES) as the course is taught at Spanish educational institutions.

​
Moodle Integration

The task format is specifically designed to align with Moodle’s assignment structure, making it easy to upload generated PDFs directly to the learning platform.
The standardized format ensures:
  • Clear task identification
  • Organized exercise structure
  • Consistent student experience
  • Easy grading and feedback

​
Directory Organization

Within each didactic unit folder (e.g., UD01_IntroduccionSistemasOperativos), organize files by type: 
UD[NUMBER]_[NAME]/
├── Teoria_*.md
├── Tarea_*.md
└── Anexo_*.md
This organization allows the build script to process each category of materials with the appropriate template and styling.

​
Best Practices

Be Consistent

Always follow the naming and formatting conventions exactly as specified.

Number Sequentially

Use sequential numbering for exercises within tasks and for file names.

Test Locally

Run the build script to verify PDFs generate correctly before committing.

Use Descriptive Names

Choose clear, descriptive names that reflect the content of each task or theory file.

Build docs developers (and LLMs) love

Get started for freeTalk to us