Während der Woche habe ich begonnen mich darüber zu informieren was eine technische Dokumentation ist bzw. wie diese aufgebaut ist.
Die meisten Quellen vergleichen eine technische Dokumentation mit einer Art Handbuch oder Betriebsanleitung.
Es sollten zum Beispiel Aspekte wie die grundlegende Projektplanung, Textgestaltung und technische Daten beachtet und nachvollziehbar dokumentiert werden.
Das folgende Bild zeigt zunächst das Deckblatt unserer Dokumentation.
Des Weiteren sollten Themen wie Entwicklung und Konstruktion Teil der Dokumentation sein. Beginnen könnte man die Dokumentation mit einem sogenannten Projektauftrag, welcher die Gegebenheiten wie Projektleitung, Mitglieder, Auftragsgeber und Projektziel beinhaltet. Weiterführend kann mit einer Projektbeschreibung zunächst das Projektziel ausführlich beschreiben.
Anschließend kann man den Erstellungsprozess dokumentieren und beschreiben bis hin zur technischen Unterstützung und deren Werkzeugen.
Anschließend kann man die Schwächen und Tendenzen des Projektes beziehungsweise des Ablaufes dokumentieren.
Unsere Gliederung könnte wie folgt aussehen
Keine Kommentare:
Kommentar veröffentlichen