Technische Dokumentation
H | 03-ME-799.99a
In einer durch Technik geprägten Welt kommt der Technischen Dokumentation eine enorme Bedeutung zu. Sie erstreckt sich von der Dokumentation von Quellcode bis hin zur Erstellung von Handbüchern für die Endnutzer eines technischen Systems. In dieser Veranstaltung werden spezifische Dokumentationsformen auf den verschiedenen Ebenen über den Entwicklungsprozess hinweg beleuchtet. Ziel ist es, den Teilnehmenden zentrale Kompetenzen in diesem sehr relevanten und interessanten Bereich zu vermitteln.
Inhalte:
- Technische Dokumentation innerhalb des Entwurfs- und Entwicklungsprozesses
- Annotationen (zur Nutzung in der IDE, zum Verständnis für andere Programmierer, zur Generierung von Handbüchern)
- automatische Informationsextraktion aus Code
- Toolunterstützte coding guidelines („Der Code ist die Doku“)
- Technische Dokumentation für Endanwender
- Gliederung und Verständlichkeit von Dokumentationen
- Texte, Abbildungen und Videos in Dokumentationen
- Qualitätskriterien für Dokumentationen
Ziele:
- Erwerb von Wissen über Methoden zur Erstellung von Technischen Dokumentationen
- Erwerb von Wissen über Qualitätskriterien
- Erwerb von Kompetenzen zur Überprüfung von Qualitätskriterien
- Anwendung der erlernten Konzepte durch praktische Übungen
- Entwurf einer eigenen Technischen Dokumentation
Veranstalter:
Cornelia Große, Oliver Keszöcze
Ort & Zeit:wöchentlich, Mo 08:00 - 10:00 Uhr,
MZH 1460
