Zum Hauptinhalt springen

Dokumentationslebenzyklus

Documention Lifecylce


Technische Dokumentation im Produktlebenszyklus

Die folgende Aufzählung zeigt typische Technische Dokumente entlang des IT-Produktlebenszyklus

TRANSFORM

GOVERNANCE-Dokumentation
Hier werden Technische Dokumentente zusammengestellt die als Vorgaben und Orientierungsrahmen verwendet werden.

  1. Governance-Unterlagen
  2. Richtlinien - Policy
  3. IT-Richtlinien für Backup and Restore. Backup and Restore Policy - Handlungs- bzw. Ausführungsvorschriften
  4. IT-Richtlinien für Verhalten. Code of Conduct - Verhaltenskodex.
  5. IT-Richtlinien für Notfälle. Continuity Policy - Notfallrichtlinie.
  6. IT-Richtlinien für Datenschutz. Datenschutzrichtlinien, Richtlinien zum Datenschutz, Datenschutzbestimmungen nach DSGVO.
  7. Richtlinien für Dokumentation. Documentation Policy.
  8. BPM-Documentation Policy
  9. IT-Documentation Policy
  10. PM-Documentation Policy
  11. IT-Richtlinien für IAM. Identity and Access Policy.
  12. IT-Richtlinien für Releases. Release Policy.
  13. IT-Richtlinien für Risikomanagement. Risk Management Policy
  14. IT-Richtlinien zur Infmationssicherheit. Security Policy. Informationssicherheitsrichtlinie, Richtlinie zur Informationssicherheit.
  15. IT-Richtlinien zu Servicevereinbarungen. Service-Level Management Policy (SLM).
  16. Anweisungen, Arbeitsanweisungen
  17. Verfahrensanweisungen, Prozessdokumentation - Practices
  18. Anleitungen
  19. Wissens-Ressourcen
  20. Schulungsunterlagen, Trainingsunterlagen, Lernunterlagen.
  21. eBook zur Wissensvermittlung
  22. White Papers
  23. Aufzeichnungen - Nachweisdokumente, Transaktionsaufzeichnungen zur Erfüllung von
  24. rechtlichen Anforderungen (Unterweisungspflicht für Arbeitgeber von einer Vielzahl von Gesetzen, Verordnungen und Vorschriften).
  25. kommerzielle Anforderungen
  26. organisatorischen Anforderungen
  27. technischen Anforderungen

CHANGE

DELIVERY-Dokumentation
Hier werden Technische Dokumentente zusammengestellt die für die Konzeption, den Bau und die Einführung von Produkten verwendet werden.

  1. Konzeption
  2. Projektdokumentation Analyse und Design, Konzeptionsdokumentation
  3. Bau
  4. Projektdokumentation Bau Entwicklungsdokumentation
  5. Funktionsanleitungen, Produktdokumentation, Softwarehandbuch
  6. Verifizierungs-Nachweise: Testpläne, Testfall-Spezifikationen, Testexekution-Protokolle
  7. Release-Notes
  8. Delivery-Notes - Lieferscheine
  9. Einführung
  10. Installationsanleitung, Montageanleitung, Installationshandbuch, Installation Manual, Deployment Instructions, Installationsprotokolle.
  11. Konfigurationsanleitung, Konfigurationsprotokolle
  12. Inbetriebnahmeanleitung
  13. Freigabedokumente, Acceptance-Notes

RUN

OPERATIONS-Dokumentation
Hier werden Technische Dokumentente zusammengestellt die für die Bereitstellung, den Betrieb und den Abbau von Produkten verwendet werden.

  1. Bereitstellung
  2. Produktkataloge, Produktblatt, Produkt-Steckbrief, Produkt-Spezifikation.
  3. Produktunterlagen für Marketing und Vertrieb.
  4. Ersatzteilkataloge, Dokumente zur Technische Unterstützung.
  5. Sicherheitsanleitung, Sicherheitshinweise.
  6. Transportanleitung, Transporthinweise zur Verteilung.
  7. Lagerungsanleitung, Lagerhinweise zu Verpackung und Lagerung.
  8. Kurzanleitung, Quick Manuals.
  9. Betrieb
  10. Bedienungsanleitungen, Gebrauchsanleitung, Gebrauchsanweisung, User Manuals
  11. Betriebsanleitungen, Betriebshandbuch, Administrationshandbuch, Serviceanleitungen
  12. Service-Reports, Service-Tickets, Service-Bulletin (Dokumentation einzelner Supportfälle
  13. Wartungsanleitung, Wartungshinweise, Wartungsplan, Hilfsstofflisten
  14. Abbau
  15. Deinstallationsanleitung, Außerbetriebnahmeanleitung
  16. Entsorgungsanleitung