Zusammenfassung

Die Dokumentation für die Endanwendung entwickeln und pflegen

Beschreibung

Diese spezifische Praktik erstellt die Dokumentation, die bei der Installation, dem Betrieb und der Instandhaltung des Produkts verwendet wird, und erhält sie aufrecht.

Beispiele für Arbeitsergebnisse



  1. Material für die Schulung der Endanwender
  2. Anwenderhandbuch
  3. Bedienungshandbuch
  4. Wartungshandbuch
  5. Onlinehilfe

Subpraktiken



1. Die Anforderungen, das Design, das Produkt und die Testergebnisse überprüfen, um sicherzustellen, dass Punkte, die die Installations-, Betriebs- und Wartungsdokumentation betreffen, erkannt und gelöst werden



2. Effektive Methoden zur Erstellung der Installations-, Betriebs- und Wartungsdokumentation verwenden



3. Geltende Dokumentationsstandards einhalten

 

Beispiele für Dokumentationsstandards umfassen:
  • Kompatibilität mit vorgeschriebenen Textverarbeitungsprogrammen
  • Zugelassene Schriftarten
  • Nummerierung von Seiten, Abschnitten und Absätzen
  • Übereinstimmung mit einem vorgeschriebenen Stilhandbuch
  • Verwendung von Abkürzungen
  • Kennzeichnung der Sicherheitsklassifizierung
  • Vorgaben zur Internationalisierung



4. Vorläufige Versionen der Installations-, Betriebs- und Wartungsunterlagen in einem frühen Stadium des Projektlebenszyklus zur Überprüfung durch die relevanten Stake-holder erstellen



5. Peer-Reviews der Installations-, Betriebs- und Wartungsunterlagen durchführen

Mehr zu Durchführung von Peer-Reviews steht im Prozessgebiet »Verifizierung (VER) (CMMI-DEV)«.



6. Installations-, Betriebs- und Wartungsdokumentation bei Bedarf überarbeiten

 

Beispiele für Fälle, in denen die Dokumentation möglicherweise überarbeitet werden muss, umfassen das Eintreten folgender Ereignisse:
  • Änderungen an Anforderungen werden durchgeführt.
  • Änderungen am Design werden durchgeführt.
  • Änderungen am Produkt werden durchgeführt.
  • Fehler in der Dokumentation werden erkannt.
  • Workarounds werden identifiziert.