Technische Dokumentation
Inhaltsverzeichnis
Aus rechtlichen Gründen werden keine der unten gelisteten Dokumente veröffentlicht. Ich behalte mir jedoch vor, im Rahmen künftiger "interner" Projekte einzelne Fragestellungen herauszugreifen und aufgrund der gewonnenen Erfahrung - in abstrahierter Form - zu behandeln.
Entwickler müssen Dokumente zur Beschreibung ihrer Quelltexte liefern. Sie empfinden nicht selten diese Tätigkeit als unangehneme Zusatzarbeit. Die Gründe dafür sind vielfätig:
-
Wenn eine textuelle Dokumentation angefordert wird, muss der Ausführende die Schriftsprache des Projektes gut beherrschen.
-
Auch ist ein hohes Maß an analytischem und synthetischem Vermögen erforderlich, um das Wesentliche zu beschreiben.
-
Meistens bleibt nach Fertigstellung der Softwaremodule zu wenig Zeit, um zusätzlich eine ausführliche Dokumentation anzufertigen.
In Projekten der Giesecke & Devrient GmbH (vgl. Projekte 14 bis 19 der chronologischen Darstellung) wurde Folgendes den (Test-)Entwicklern vorgeschrieben:
-
Zum einen mussten sie eine Beschreibung ihrer Module in das Pflichtenheft einpflegen (in DOORS Format).
-
Zum anderen wurde der Quellentext - Javacard, C, C++ - mit speziell markierten Kommentaren versehen, auf deren Basis, das Tool DOXYGEN eine HTML-Dokumentation erzeugt.
Im AGS-Projekt werden alle Module der AGS-Software mit dem Tool MATLAB-Simulink nachgebildet. Daraus werden Grafiken automatisch generiert, die in weiteren - weitegehend automatisierten - Schritten einem Dokument hinzugefügt werden, das die gesamte Software beschreibt und je nach Wunsch als PDF oder HTML-Datei zusammengestellt wird.
Für Tests mit dem ECU-Testtool gelten die während der Testdurchführung erstellten Testberichte - in HTML-Format - als grundlegende entwicklernahe Dokumentation. Für einige Testsskripte gibt es zusätzlich beschreibende Unterlagen in WORD-Format, die schwer zu pflegen sind, weil die Zeit nie ausreicht.
Die Dokumentation der Quelltexten bildet eine kleine Untermenge des Dokumentierungsaufwandes in Software-Entwicklungsprojekten. Im Projekt Multiplate Dokumentation übernahm ich ein breites Spektrum aus diesem Tätigkeitsfeld, nämlich das Dokumentieren von Prozessen und von Teilen der Hardware und Software - in enger Zusammenarbeit mit Experten und Entscheidungsträgern.
-
Auswahl von Dokumenten zur Beschreibung von Firmen-Prozessen, (vgl. SOP)
SOP für Abteilung 'Produktion':Titel / Thema Erst veröffentlicht am Umfang Vorgehensweise zur Eingangskontrolle der Messelektronik 11.2006 18 Seiten Sicherung der Daten eines zurückgesendeten Multiplate Gerätes 02.2009 6 Seiten Übertragung von existierenden Kundendaten auf ein neues multiplate Gerät 02.2009 6 Seiten SOP für Abteilung 'Software-Entwicklung':Titel / Thema Erst veröffentlicht am Umfang Verwaltung der CPs zur Firmware 03.2009 Verwaltung der CPs zur Installationssoftware 03.2009 Verwaltung der CPs zur Software 04.2009 Bearbeitung von Mitteilungen zu Software -Fehlern oder -Verbesserungsvorschlägen, Graphische Darstellung 08.2009 1 Seite SOP für IT-Abteilung:Titel / Thema Erst veröffentlicht am Umfang NetzwerkAdministration 03.2009 11 Seiten SOP für Abteilung 'Qualität-Sicherung:Titel / Thema Erst veröffentlicht am Umfang Validierung der Benutzerschnittstelle vom multiplate-Geräte 01.2009 76 Seiten SOP abteilungsübergreifend:Titel / Thema Erst veröffentlicht am Umfang Netzwerksicherheit 12.2007 27 Seiten Topologie des Firmennetzwerkes 03.2008 18 Seiten Aktualisierung der Windows Office Programme 03.2009 3 Seiten Allgemeine Netzwerk-Richtlinien 03.2010 7 Seiten -
Auswahl von Dokumenten zur Beschreibung von Teilen der Hardware
Titel / Thema Erst veröffentlicht am Umfang Grundlage der Rührelektronik 07.2007 5 Seiten Technische Spezifikation des Schrittmotors 07.2007 4 Seiten Technische Spezifikation der Prüfelektronik Teil A 10.2007 18 Seiten Technische Spezifikation der Elektonik zur Steuerung der eLine-Pipette 06.2008 20 Seiten Validation der Rührelektronik Teil A 08.2008 18 Seiten Konzepte zur Weiterentwicklung der Messelektronik 10.2008 3 Seiten Validierung der Prüfelektronik MCON-1x 11.2008 7 Seiten Technische Spezifikation der Prüfelektronik MCON-2x 12.2008 45 Seiten Stand der Weiterentwicklung aller Hardware-Komponenten des Multiplate Gerätes 01.2009 6 Seiten Liste aller Hardware-Konfigurationen des Multiplate-Messgerätes 03.2009 3 Seiten -
Auswahl von Dokumenten zur Beschreibung von Teilen der Software
Titel / Thema Erst veröffentlicht am Umfang Lastenheft der Multiplate Software (User Requirements) (unvollständig) 03.2008 18 Seiten Software Spezifikation, Pflichtenheft (Answer to User Requiremenst) 05.2008 88 Seiten Beschreibung der implementierten Algorithmen zur Ermittlung der Multiplate Größen BCS und ACL 08.2008 29 Seiten Konzeptpapier zu MCAL, Softwaremodul für die integrierte Kalibration der Messung 01.2009 9 Seiten Ergebnisse von Testserie-1 zur Verifizierung des internen Kalibrationsmoduls MCAL 04.2010 20 Seiten Ergebnisse von Testserie-2 zur Verifizierung des internen Kalibrationsmoduls MCAL 04.2010 15 Seiten Validierung der Multiplate Software-Version 2.4.x 07.2010 31 Seiten Bedienung eines Multiplate-Gerätes: Hintergrundinformation für den Anwender 08.2010 8 Seiten Softwaremetrik: Analyse des Quelltextes nach Modulen, inklusive Kostenbetrachtung 09.2010 9 Seiten Ergebnisse von Testserie-3 zur Validierung des internen Kalibrationsmoduls MCAL im Deutschen Herzzentrum 11.2010 79 Seiten -
Einige der behandelten Themen bleiben für mich aktuell. Ideen, Methoden, Quelltexte, die im Rahmen meiner Mitarbeit entworfen wurden, konnten nicht vollständig umgesetzt werden: Sie wurden für künftige Schritte ausgespart. Dazu gehören folgende Aufgaben:
- C++-Programmierung von Modulen zur Aufbereitung und Kalibrierung von Messdaten
- Mathematische/numerische Modellierung der gemessenen Thrombozyten-Aggregation. Ich bin der Ansicht, dass die Kalibration von Aggregometrie-Messdaten durch den verstärkten Einsatz von mathematischen Modellen deutlich verbessert - u.a. weniger störungsanfällig - wird.
Ich behalte mir vor, diese Themen allgemeingültig im Rahmen von internen Projekten näher zu untersuchen.