Entwicklungsdokumentation in Software-Projekten

Zweck, Aufbau und Nutzen der Dokumentation von Software-Projekten

Auf einen Blick

2 Tages-Seminar
location_onvideocam Flex-Option 13.03.2023 - 14.03.2023
8:45 Uhr
in Ostfildern bei Stuttgart

Technische Akademie Esslingen
An der Akademie 5
73760 Ostfildern

EUR 1.040,00(MwSt.-frei)
weniger bezahlen – so geht´s
Veranstaltung Nr. 32763.00.024


Referentin:
Prof. Dr. Gertrud Grünwied
Neu-Ulm

Seite Entwicklungsdokumentation%20in%20Software%2DProjekten als PDF speichernSeite als PDF speichern

Seminar weiterempfehlen

Inhouse-Durchführung anfragen


Teilnehmer dieser Veranstaltung interessierten sich auch für

Beschreibung

Häufig trifft man in der Praxis nicht dokumentierte Programme und nie nachgeführte Entwicklungsdokumente an. Die Dokumentation ist aber ein wichtiges Kommunikationsmittel in der Softwareentwicklung. Fehlt diese, kann eine Software kaum weitergeführt werden. Es entstehen (vermeidbare) Kosten für neue Software.

Ziel der Weiterbildung

In diesem Seminar lernen Sie Zweck, Aufbau und inhaltliche sowie sprachliche Gestaltung der Dokumention in der Softwareentwicklung kennen. Der Unterschied zwischen Projekt-, Produkt- und Prozess-Dokumenten wird vermittelt. Sie erfahren, welchen Nutzen Systemdokumentation für Software-Architekten, Entwickler, Tester und Projektverantwortliche hat. Das Seminar behandelt auch den rechtlichen und normativen Rahmen von Software-Dokumentation. Sie erfahren, in welchem Maße heute bei klassischer oder agiler Vorgehensweise dokumentiert werden muss. Anschauliche Beispiele und Übungen runden das Seminar ab.

Sie erhalten Qualität
Das Qualitätsmanagementsystem der Technischen Akademie Esslingen ist nach DIN EN ISO 9001 und AZAV zertifiziert.

Teilnehmer:innenkreis

Dieses Seminar richtet sich an Mitarbeiter in der Softwareentwicklung. Projektverantwortliche, Architekten, Entwickler und Tester lernen, was man wie dokumentiert. Den Verantwortlichen wird das Kosten-Nutzen-Verhältnis einer sorgfältig erstellten Dokumentation vermittelt.

Inhalte

Montag, 13. und Dienstag, 14. März 2023
8.45 bis 12.00 und 13.30 bis 16.45 Uhr

1. Einleitung
> Sinn und Zweck von Entwicklungsdokumentation
> Dokumentation im Software-Lebenszyklus
> Software-Vorgehensmodelle und Prozess-Dokumentation
> Dokumentklassen - Projekt / Produkt / Prozess
> Rechtliche und normative Vorgaben

2. Produkt-Dokumentation je Phase im Lebenszyklus
(je unterschieden nach klassischer oder agiler Entwicklung)
> Planung: Projekt-Dokumentation, Prozess-Dokumentation
> Anforderungsanalyse: Use Case Diagramm, Lastenheft und Pflichtenheft, User Storys mit Akzeptanzkriterien, Story Mapping
> Design und Konzeption: Architekturbeschreibungen, Klassen- und Sequenzdiagramme, UI Styleguides, Use Cases detailliert
> Implementierung: Code-Dokumentation (Inline, Developer Guidelines), API-Dokumentation, Interaktive Dokumentation
> Testen: Testdokumentation
> Wartung und Weiterentwicklung: Problembeschreibungen, Änderungsdokumentation
> Von der Entwickler- zur Benutzerdokumentation

3. Gestaltung von Dokumenten
> Aufbau und Orientierungshilfen
> Terminologie und Texte, Regeln für Verständlichkeit
> Informationseinheiten als Topics (Task, Concept, Reference)
> Tabellen und Diagramme

4. Erstellung und Verwaltung von Dokumentation
> Metadaten zur Kennzeichnung
> Redaktionelle Tools, Doc as Code, Wikis
> Templates, Dokumentenmanagement

Referent:innen

Referentin:
Prof. Dr. Gertrud Grünwied
Gertrud Grünwied ist Gründerin des Studiengangs "Technische Redaktion und Kommunikation" an der Hochschule München und ist dort seit 2011 als Professorin tätig. Ihre Fachbereiche sind Softwaredokumentation, Usability und Informationsmanagement. Sie ist Buchautorin und Expertin in internationalen Normungsgremien zu Technischer Dokumentation. Die Elektroingenieurin und Informatikerin promovierte über die Mensch-Computer-Interaktion.

Termine & Preise

Extras
Die Teilnahmegebühr beinhaltet ausführliche Seminarunterlagen und bei Teilnahme vor Ort Verpflegung.

Kosten
Die Kosten betragen pro Teilnehmer EUR 1.040,00(MwSt.-frei), inklusive aller Extras.

Fördermöglichkeiten
weniger bezahlen – so geht´s

Die nächsten Termine

Datum / Uhrzeit Seminartitel Ort Preis
13.03.2023, 8:45 Uhr Entwicklungsdokumentation in Software-Projekten Ostfildern$$ortdetail$$ EUR 1.040,00

© Technische Akademie Esslingen e.V., An der Akademie 5, 73760 Ostfildern  | Impressum