Datei Struktur

Die IT-Architekturrichtlinien werden in Markdown-Dateien verfasst. Die Dateien werden in einem Repository verwaltet und können über ein Versionskontrollsystem bearbeitet werden. Die Dateien sind in einem Verzeichnisbaum organisiert, der die Struktur der Richtlinien abbildet.

Regeln für die Datei Struktur

Das Dokument muss in einem Verzeichnisbaum organisiert sein, welcher den folgenden Regeln entspricht:

Dokument:

1. Das Gesamte Dokument muss in einem Ordner zusammengefasst sein (z. B. /dokument)
2. Jedes Kapitel wird in einem eigenen Unterordner abgelegt.
3. Jedes Kapitel kann in weitere Unterordner unterteilt werden.
4. Die Sortierung können Sie über die Nummerierung der Ordner und Dateien steuern (z. B. 01-kapitel, 02-kapitel). Standardmäßig wird die Sortierung alphabetisch vorgenommen.
5. Medien (Bilder, Videos, etc.) werden in einem eigenen Ordner mit dem Namen assets abgelegt. Dieser ist im Wurzelverzeichnis des Dokuments zu finden (z. B. /dokument/assets).

Dateinamen:

1. Dateien, die in allen Ausgabenformaten berücksichtigt werden sollen, haben die Endung .md (Markdown). Dateien, die nur in den Web-Ansichten berücksichtigt werden sollen, haben die Endung .web.md oder .mdx (Markdown). Dateien, die nur in den PDF-Ansichten berücksichtigt werden sollen, haben die Endung .pdf.md (Markdown). Die spezifischere Endung hat Vorrang.
2. Die Dateinamen enthalten keine Leerzeichen und keine Sonderzeichen (außer - und _).
3. Die Dateinamen enthalten keine Umlaute oder nicht lateinische Zeichen.

Template:

1. In einem Ordner außerhalb des Dokuments sind Template-Dateien abzulegen (z. B. /template).
2. Für das Ausgabeformat PDF existiert eine template.tex-Datei im Template-Ordner (/template/template.tex). Diese Datei beeinflusst das Styling des PDF-Dokuments. Sie muss mindestens einige Variablen enthalten, um den Inhalt in das Template einfügen zu können. Für mehr Datails hierzu können Sie auf die folgende Vorlage zurückgreifen: template.tex der IT-Architekturrichtlinien. Daneben finden Sie weitere Informationen in der technischen Dokumentation.

Beispiel Dateistruktur

Dokument

Das folgende Beispiel zeigt einen Auszug der Dateistruktur der IT-Architekturrichtlinie des Bundes:

Template

Das folgende Beispiel zeigt die Dateistruktur des Template-Ordners: