From 82a339e515a19add3c7ee708da9aa6a43b6a7f1d Mon Sep 17 00:00:00 2001 From: Adam Gaiswinkler Date: Mon, 17 Mar 2025 14:55:30 +0000 Subject: [PATCH] Dokumenten Management und Dokumentationsstandards aktualisiert --- ...-Management-und-Dokumentationsstandards.md | 63 ++++++++++++++++++- 1 file changed, 62 insertions(+), 1 deletion(-) diff --git a/Dokumenten-Management-und-Dokumentationsstandards.md b/Dokumenten-Management-und-Dokumentationsstandards.md index ea78fbf..c63f471 100644 --- a/Dokumenten-Management-und-Dokumentationsstandards.md +++ b/Dokumenten-Management-und-Dokumentationsstandards.md @@ -1 +1,62 @@ -Willkommen im Wiki. \ No newline at end of file +# **Dokumentenmanagement – Benennung von Dokumenten** + +Beim Speichern von Dokumenten wird eine einheitliche Namenskonvention verwendet, um eine klare Struktur und schnelle Auffindbarkeit zu gewährleisten. + +⸻ + +## Richtiges Namensschema: + +### 📌 Format:
+ +YYYY-MM-DD-Dokumententyp-Kurztitel-Version + +### 📌 Erklärung:
+ +1. Datum (YYYY-MM-DD) – Erstellungsdatum des Dokuments. +2. Dokumententyp – Art des Dokuments (z. B. Projekt-Dokumentation, Gesprächsprotokoll, Lastenheft, Pflichtenheft, Präsentation). +3. Kurztitel (optional) – Falls notwendig, eine kurze Beschreibung zur besseren Identifikation. +4. Version (VX.X) – Versionsnummer des Dokuments (z. B. V1.0 für die erste Version, V1.1 für kleinere Änderungen, V2.0 für größere Überarbeitungen). + +⸻ + +### ✅ Beispiele für korrekte Dokumentennamen:
+ +• 2025-03-17-Projekt-Dokumentation-Initial-V1.0 + +• 2025-03-17-Gesprächsprotokoll-Kickoff-Meeting-V2.1 + +• 2025-03-17-Lastenheft-Modul-V1.3 + +• 2025-03-17-Pflichtenheft-API-Spezifikation-V1.0 + +• 2025-03-17-Präsentation-Strukturplanung-V1.2 + +⸻ + +### ❌ Fehlhafte Benennungen und warum sie falsch sind: + +**1. Ohne Datum:** + +• Projekt-Dokumentation-Initial-V1.0 → Datum fehlt, keine zeitliche Einordnung möglich. + +**2. Ohne Dokumententyp:** + +• 2025-03-17-Initial-V1.0 → Unklar, um welche Art von Dokument es sich handelt. + +**3. Unklare Abkürzungen oder zu lange Namen:** + +• 2025-03-17-PD-Init-V1.0 → PD ist nicht eindeutig als “Projekt-Dokumentation” erkennbar. + +• 2025-03-17-Projekt-Dokumentation-Erste-Version-Final-Überarbeitung-Endgültig-V1.0 → Zu lang und unübersichtlich. + +**4. Fehlende oder inkonsistente Versionierung:** + +• 2025-03-17-Projekt-Dokumentation-Initial → Version fehlt, Änderungen sind nicht nachvollziehbar. + +• 2025-03-17-Projekt-Dokumentation-Initial-1 → Version sollte als V1.0 geschrieben werden. + +**5. Falsche Trennzeichen oder Sonderzeichen:** + +• 2025_03_17-Projekt Dokumentation Initial V1.0 → Mischung aus Unterstrichen, Leerzeichen und falschem Format. + +• 2025.03.17-Projekt-Dokumentation-Initial-V1.0 → Datum sollte mit Bindestrichen getrennt sein.