DE 
EN 1. Einleitung
Für viele Hardware- und Softwareentwickler gilt die Dokumentation als notwendiges Übel. Dabei ist sie ein integraler Bestandteil der Produktentwicklung, insbesondere bei der steigenden Komplexität moderner Produkte. Dokumentationen sind nicht nur Nachweise, sondern auch Werkzeuge, um das Produktdesign zu verstehen, zu validieren und schlussendlich die Produktfreigabe zu ermöglichen.
Die zentrale Frage lautet: Wie entstehen produktentwicklungsbegleitende technische Dokumente möglichst effizient? Dies führt zu zwei Kernaspekten:
a) Welche Dokumente sind zwingend erforderlich und wie sollten sie strukturiert sein?
b) Wie lassen sich diese Dokumente möglichst schnell und vollständig erstellen?
Die Antwort liegt in einer Kombination aus modellbasierter Entwicklung und der teilautomatisierten Erstellung aller entwicklungsbegleitenden Dokumente.
2. Erforderliche produktentwicklungsbegleitende Dokumente
Folgende Dokumente werden benötigt, um die Entwicklungsziele zu erreichen:
- Designdokumente: Architekturdesign und Detaildesign,
- Designanalysedokumente: Analysen zur Fehlererkennung und -vermeidung,
- Anforderungsdokumente: Technische Anforderungen,
- Testspezifikationen und Testberichte: Nachweis der Funktion und Sicherheit sowie weiterer essentieller Eigenschaften des Produkts,
- Prozessbeschreibungen: Nachweis der normkonformen Arbeitsweise im Projekt.
Struktur und Inhalte der Designdokumente
Die Designdokumente beschreiben die Produktarchitekturebenen von der System- über die Hardware- bis zur Softwareebene. Diese enthalten:
- Name und Konfiguration des „Muttersystems“ der übergeordneten Ebene,
- Betriebsmodi, Systemzustände und -übergänge des „Muttersystems“,
- Funktionen und Schnittstellen der Elemente,
- Gesetze, Normen und Vorschriften, die zu beachten sind.
Anforderungs- und Testdokumente
Technische Anforderungsdokumente enthalten für das gesamte zu entwickelnde Produkt und alle seine Elemente:
- Funktionale dynamische Anforderungen,
- Zustandsbezogene dynamische Anforderungen,
- Schnittstellenbezogene dynamische Anforderungen sowie
- Statische Qualitätsanforderungen.
Testspezifikationen und Testberichte dokumentieren, dass alle Anforderungen erfüllt und die Sicherheitsmechanismen korrekt implementiert sind.
3. Effiziente Erstellung der Dokumenteninhalte
Die Inhalte der Dokumente werden durch eine Kombination aus automatisierter Modellgenerierung und strukturierter Dokumentation erstellt. Hierbei ist zu beachten:
„Das Modell steckt in den Dokumenten.“ Die Designspezifikationen dienen als Grundlage für die automatische Erstellung von Signalflussmodellen, die als Simulink®-, SysML®- oder UML®-Diagramme dargestellt werden können.
Wir bevorzugen tabellarisch strukturierte Dokumente im Vergleich zu skriptartigen Dokumenten wie beispielsweise XML-Files.
Vorteile tabellarischer Dokumente
- Kompatibilität: Alle gängigen Application Lifecycle Management (ALM)-Lösungen und Dokumentenmanagementsysteme unterstützen tabellarische Dokumente.
- Flexibilität: Einfacher Export und Import sowie Bearbeitung mit gängigen Tabellenkalkulationsprogrammen wie Excel®.
- Maschinenlesbarkeit: Ermöglicht die automatisierte Generierung und Prüfung von Dokumenteninhalten.
- Konsistenz: Inhalte werden hierarchisch und aufeinander abgestimmt erstellt.
Rolle der autoConform®-Software Suite
Die autoConform®-Software Suite unterstützt durch:
- Automatische Generierung und Prüfung der Dokumenteninhalte,
- Konsistenzprüfungen zwischen den Dokumenten,
- Effiziente Integration in bestehende Dokumentenmanagementsysteme.
4. Zusammenfassung
Eine effiziente Erstellung technischer Dokumente basiert auf der Kombination von modellbasierter Entwicklung und teilautomatisierter Dokumentation. Die Verwendung tabellarischer textueller Dokumente stellt sicher, dass alle relevanten Informationen abgedeckt und leicht überprüfbar sind. Mit Tools wie der autoConform®-Software lassen sich diese Dokumente nicht nur schneller, sondern auch konsistenter und vollständiger erstellen.
