Zunächst habe ich aufgrund der Email von Herrn Iurgel das Inhaltsverzeichnis einmal überarbeitet:
Die Änderungen belaufen sich zwar auf minimale Änderungen dennoch ist es angepasster an die Vorstellungen einer technisches Dokumentation. Der folgende ist ein Beispiel welcher Punkt geändert und neu hinzugefügt wurde.
Inbetriebnahme
- Welche Programme müssen installiert sein, welche Pfade gesetzt, welche elektronischen Komponenten wie verschaltet werden usw., um das System zu starten? Welche Datei startet das System?
- Benennen Sie auch Programmversionen. Geben Sie alle nötigen Informationen, aber schreiben Sie hier (wie auch woanders) nichts Unnötiges. Listen Sie also zum Beispiel auf, welche Softwareversionen installiert werden müssen, aber nicht, wie man sie installiert, wenn man dieses Wissen bei einem Informatiker voraussetzen kann, oder es eine Installationsanleitung beim Hersteller gibt.
- Verwenden Sie hier (wie auch woanders), wo es sinnvoll ist, Skizzen und Screenshots.
Im folgen den sind beispielhaft 2 Seite der technische Dokumentation beigefügt. Es handelt sich um einen groben Projektauftrag und der erste Ansatz der Projektbeschreibung:
Die Projektbeschreibung dient als eine Einführung in der Projekt als Grundlage zum Verständnis. Sie beschriebt ein wenig den Aufbau beziehungsweise die Vorgehensweise des erzielten Projektes. Daraufhin folgen die technischen Informationen,welche einen Einblick in die Nutzung der Software etc. bringt.
