81 lines
2.9 KiB
Typst
81 lines
2.9 KiB
Typst
|
|
#import "@local/chfoit-ipa:0.0.0": acronym, term
|
|
|
|
// IPA-Dokumentenvorgabe BiVo2021-2:
|
|
//
|
|
// Wie werden die Ergebnisse der IPA abgelegt und was wird unternommen,
|
|
// um die Ergebnisse der IPA vor Verlust zu schützen.
|
|
// Beispiel:
|
|
// • Backup-Konzept: was wird wie und wann gesichert
|
|
// • Einsatz von Sourcecode-Verwaltungssystemen: wie wird damit
|
|
// gearbeitet
|
|
// ➔ Die Nachweise (Backup Log, Commit History, …) müssen innerhalb
|
|
// des Anhangs der Dokumentation abgegeben werden.
|
|
= Organisation der IPA-Ergebnisse
|
|
|
|
#lorem(200)
|
|
|
|
// == Arbeitsplatz
|
|
//
|
|
// #figure(
|
|
// image("../../02_Grafiken/arbeitsplatz.png", width: 80%),
|
|
// caption: [Arbeitsplatz der IPA],
|
|
// ) <fig-arbeitsplatz>
|
|
//
|
|
// Beschreibung des Arbeitsplatzes, der verwendeten Arbeitsgeräte und
|
|
// Hilfsmittel (z. B. Editor, Satzsystem, Diagrammwerkzeug).
|
|
//
|
|
// == Verwaltung der Ergebnisse
|
|
//
|
|
// Die Ergebnisse werden jeweils in einem Git #term(
|
|
// "Repository",
|
|
// "Ein zentraler, digitaler Speicherort für Daten, Dateien und Projektunterlagen,
|
|
// der eine strukturierte Verwaltung, Versionierung und gemeinsame Nutzung (Kollaboration) ermöglicht.",
|
|
// ) verwaltet. Eines für die Dokumentation und eines für den Code.
|
|
//
|
|
// Die Dokumentation ist in folgender Verzeichnisstruktur abgelegt:
|
|
//
|
|
// #figure(
|
|
// image("../../02_Grafiken/dirtree.png", width: 80%),
|
|
// caption: [Verzeichnisbaum der IPA],
|
|
// ) <fig-dirtree>
|
|
//
|
|
// #pagebreak(weak: true)
|
|
// #show table.cell.where(x: 0): set text(font: "Fira Mono")
|
|
// #figure(
|
|
// table(
|
|
// columns: (auto, auto),
|
|
// table.header([Verzeichnis], [Beschreibung]),
|
|
// [01_Dokumentation], [Alle Informationen, die in der Dokumentation verwendet werden.],
|
|
// [01_Dokumentation/01_Teil1], [Kapitel des Teil 1 als einzelne Typst-Dateien.],
|
|
// [01_Dokumentation/02_Teil2], [Kapitel des Teil 2 als einzelne Typst-Dateien.],
|
|
// [01_Dokumentation/03_Anhang], [Kapitel des Anhangs als einzelne Typst-Dateien.],
|
|
// [02_Grafiken], [Jegliche Grafiken, die für die Dokumentation verwendet werden.],
|
|
// [03_Zeitplan], [Hier wird der Zeitplan abgelegt],
|
|
// [04_Code], [Ablage für den Code. Wird in Git als Submodul gespeichert.],
|
|
// ),
|
|
// caption: [Erklärung der Ordnerstruktur der IPA],
|
|
// ) <ordnerstruktur-erklärung>
|
|
//
|
|
// == Datensicherung IPA
|
|
//
|
|
// === Code
|
|
//
|
|
// Der Code wird mit dem Versionsverwaltungstool Git versionisiert.
|
|
// Damit können einfach Teil-Features gepusht werden und es bleiben jederzeit
|
|
// alle Änderungen nachvollziehbar. Ebenfalls kann jederzeit auf einen alten
|
|
// Stand zurückgespielt werden.
|
|
//
|
|
// ==== Branch-Strategie
|
|
//
|
|
// #figure(
|
|
// image("../../02_Grafiken/branch-strategy.png", width: 80%),
|
|
// caption: [Git Branch-Strategie],
|
|
// ) <fig-branch-strategy>
|
|
//
|
|
// === Dokumentation
|
|
//
|
|
// Der gesamte IPA-Ordner ist mit Git versionisiert. Nach jeder signifikanten
|
|
// Änderung wird ein Commit erstellt und gepusht. Durch die lokale Versionierung
|
|
// sowie die regelmässigen Commits ist die Dokumentation immer gesichert.
|