add README

2026-07-17 08:49:04 +02:00
parent 8e3228a845
commit 615ad69622
1 changed files with 22 additions and 0 deletions
@@ -0,0 +1,22 @@
+# Dokumentation zum Projekt "Sovereign RAG Tutor" mit mastersolution
+
+Dieses Repo enthält die Dokumentation zum Projekt "Sovereign RAG Tutor", das mit mastersolution (potenziell) durchgeführt wird, sofern die Dokumente in einem versionierbaren Format vorliegen. Bevorzugt kommt hierfür Markdown zum Einsatz, aber auch andere simple Textformate - bestenfalls mit Formatierungssyntax - sind denkbar.
+
+## Work-in-Progress
+
+Dieses Verwaltungsschema für Projektdokumentationen ist neu und wird erprobt. Es ist davon auszugehen, dass es noch Verbesserungen bzw. Anpassungen geben wird. Insbesondere die Wechselwirkung zu der Projektpflege in Open-Project ist zum aktuellen Zeitpunkt noch unklar, auch weil die Prozesse für Open-Project nicht fixiert sind und wir uns aktuell in der Erprobungsphase befinden (Stand 07/2026).
+
+## Hintergrund
+
+Im Projektverlauf werden Dokumente häufig überarbeitet und damit neue Revisionen erzeugt. In der Regel werden diese im Dateinamen, besser noch in der Datei selbst, mit Versionsnummern bezeichnet. Dieser Prozess ist allerdings fehleranfällig: 
+
+- Die Anpassung der Versionsnummer wird vergessen.
+- Eine Änderung wird am Dokument vorgenommen, ohne das Dokument vorher neu gespeichert zu haben.
+- Änderungen werden nicht mit einer Informationsmeldung durch den Dateimodifikator versehen. Informationen, warum geändert wurde sind verloren.
+- Es liegen keine detaillierten Kenntnisse über die tatsächlichen Änderungen vor (Was wurde wo wann durch wen geändert).
+
+Eine Versionierung über Git erscheint deshalb zweckmäßig. Die Bearbeitung kann über jeden Texteditor stattfinden, wobei empfohlen wird, einen Editor zu nutzen, der das Schreiben des ausgewählten Textformats mit Syntax unterstützt.
+
+## Organisation
+
+Jedes versionierbare projektrelevante Dokument wird in diesem Repo geführt. Unterordner können frei nach Bedarf und Zweckmäßigkeit erzeugt werden. Das Repo gilt als Grundwahrheit für die gemeinsame Pflege, Verwaltung und Aufbewahrung der Kundendokumente. Änderungen an den Dateien können wie von Git gewohnt mittels Commit-Nachrichten getrackt werden. Ebenfalls möglich ist die Arbeit in Branches. Das bietet sich bei der Arbeit mit Dokumentationen insbesondere dann an, wenn größere Änderungen vorgenommen werden, die in mehreren Einzelschritten (Commits) getrackt werden. Erst nach Abschluss der Arbeit wird der Zweig wieder zurück nach "main" über ein Pull-Request gezogen.