Entwicklungsdokumentation in Software-Projekten
Zweck, Aufbau und Nutzen der Dokumentation von Software-Projekten
Entwicklungsdokumentation in Software-Projekten
Dr. Kai Bellmann
Bellmann Engineering GmbH, Feucht
Herr Bellmann ist seit 2011 Geschäftsführer der Bellmann Engineering GmbH und berät in diesem Rahmen Unternehmen im Bereich Softwareentwicklung. Er verfügt über langjährige Praxiserfahrung, die er durch seine Mitarbeit bei renommierten Unternehmen wie der Siemens AG und der Datev eG gesammelt hat. Durch seine Arbeit hat Herr Bellmann einen breiten Überblick über die aktuelle Entwicklung im Bereich Softwareentwicklung und verfügt über ein Netzwerk an Experten und Kontakten in der Branche.
Als Dozent an der Volkswagen Fakultät vermittelt Herr Bellmann sein umfangreiches Wissen im Bereich Softwareentwicklung und leistet somit einen wichtigen Beitrag zur Ausbildung des Fachkräftenachwuchses.
Aufgrund seiner umfangreichen Erfahrung in der Softwareentwicklung ist er in der Lage, komplexe Probleme schnell zu erfassen und praxisorientierte Lösungen zu entwickeln.
Insgesamt zeichnet sich Herr Bellmann durch seine fachliche Kompetenz, seine kommunikative Kompetenz, seine praxisorientierte Arbeitsweise und seine analytischen Fähigkeiten aus. Er ist ein geschätzter Experte in der Branche und trägt maßgeblich zum Erfolg von Unternehmen im Bereich Softwareentwicklung bei.
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 Dokumentation 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.
Seit über 65 Jahren gehört die Technische Akademie Esslingen (TAE) mit Sitz in Ostfildern – nahe der Landeshauptstadt Stuttgart – zu Deutschlands größten Weiterbildungs-Anbietern für berufliche und berufsvorbereitende Qualifizierung im technischen Umfeld. Unser Ziel ist Ihr Erfolg. Egal ob Seminar, Zertifikatslehrgang oder Fachtagung, unsere Veranstaltungen sind stets abgestimmt auf die Bedürfnisse von Ingenieuren sowie Fach- und Führungskräften aus technisch geprägten Unternehmen. Dabei können Sie sich stets zu 100 Prozent auf die Qualität unserer Angebote verlassen. Warum das so ist?
Dienstag, 8. April 2025
9.00 bis 16.30 Uhr, inkl. Pausen
1. Einleitung
- Sinn und Zweck von Entwicklungsdokumentation
- Dokumentation im Software-Lebenszyklus
- rechtliche und normative Vorgaben
2. Produkt-Dokumentation je Phase im Lebenszyklus
(je unterschieden nach klassischer oder agiler Entwicklung)
- Planung: Projekt-Dokumentation, Prozess-Dokumentation
- Anforderungsanalyse: z.B. Use Case Diagramm, Lastenheft und Pflichtenheft, User Storys mit Akzeptanzkriterien
- Design und Konzeption: z.B. Architekturbeschreibungen, Klassen- und Sequenzdiagramme
- 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)
4. Erstellung und Verwaltung von Dokumentation
- Metadaten zur Kennzeichnung
- Überblick über redaktionelle Tools, Doc as Code, Wikis
- Templates, Dokumentenmanagement
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.
Die Teilnahme beinhaltet ausführliche Unterlagen.
Preis:
Die Teilnahmegebühr beträgt:
720,00 €
(MwSt.-frei)
Fördermöglichkeiten:
Für den aktuellen Veranstaltungstermin steht Ihnen die ESF-Fachkursförderung leider nicht zur Verfügung.
Für alle weiteren Termine erkundigen Sie sich bitte vorab bei unserer Anmeldung.
Andere Bundesland-spezifische Fördermöglichkeiten finden Sie hier.
Inhouse Durchführung:
Sie möchten diese Veranstaltung firmenintern bei Ihnen vor Ort durchführen? Dann fragen Sie jetzt ein individuelles Inhouse-Training an.
Ihr Ansprechpartner für die Veranstaltung
Der Seminarleiter hat die relevanten Themen gut beschrieben und ist auf jede Zwischenfrage eingegangen.
Weniger gut habe ich die langen Bearbeitungszeiten in den Gruppenräumen empfunden.
Sehr geehrte/r Teilnehmende/r,
vielen Dank für Ihr positives Feedback. Ihre Rückmeldung zu den langen Bearbeitungszeiten in den Gruppenräumen nehmen wir ernst. Wir werden prüfen, wie wir diesen Teil des Seminars optimieren können, damit die Arbeitsphasen in den Gruppen noch effizienter gestaltet werden und ein besseres Gleichgewicht zwischen Bearbeitungszeit und Dynamik entsteht.
Ihr Team der TAE