Dokumenten Management und Dokumentationsstandards aktualisiert
parent
3636ad3fcb
commit
82a339e515
|
@ -1 +1,62 @@
|
||||||
Willkommen im Wiki.
|
# **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:<br>
|
||||||
|
|
||||||
|
YYYY-MM-DD-Dokumententyp-Kurztitel-Version
|
||||||
|
|
||||||
|
### 📌 Erklärung:<br>
|
||||||
|
|
||||||
|
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:<br>
|
||||||
|
|
||||||
|
• 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.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user