Skip to content

Aus- und Überarbeitung des Major-Release-Bereichs

Dokumentationsseiten (Pflichtfeld)

User Story

Als Nutzer der Dokumentation möchte ich, dass die Informationen zu Major Releases klar, vollständig und strukturiert dargestellt werden, damit ich schnell nachvollziehen kann, welche Änderungen in welchem Release enthalten sind und wie sie mein Produkt betreffen.

Warum

Eine gut strukturierte Major-Release-Dokumentation hilft Entwicklern, Produktmanagern und Kundensupport, die Änderungen nachzuvollziehen, Abhängigkeiten zu verstehen und mögliche Anpassungen in eigenen Systemen frühzeitig einzuplanen. Sie erhöht die Transparenz und reduziert Rückfragen.

Erkenntnis --> Was muss dokumentiert werden? (Pflichtfeld)

  • Die Definition und Bedeutung von Major Releases im Kontext von FIT-Connect.
  • Release-Zeitplan und Historie (Datum, Version, kurze Zusammenfassung der Änderungen).
  • Auswirkungen auf bestehende Features, ggf. Breaking Changes oder Migrationsempfehlungen.
  • Hinweise, wie Nutzer weitere Details zu einzelnen Releases finden können.

Links, Hinweise, Bemerkungen

Infomaterial

LinkedIn Post: Click to expand Bildschirmfoto_2025-10-08_um_12.20.58
Newsletter: Click to expand newsletter
Nutzendenkreis Präsentation: Click to expand FIT-Connect_Sonder-Nutzendenkreis_02.10.2025.pdf FIT-Connect_Sonder-Nutzendenkreis_02.10.2025.pptx
Technikkreis Präsentation: Click to expand FIT-Connect_Sonder-Technikkreis_09.10.2025.pdf FIT-Connect_Sonder-Technikkreis_09.10.2025.pptx

Ansprechperson (Pflichtfeld)

  • Zuständiger PO: PO/BM MBO
  • Technische Ansprechperson: AT AHU, POs, Devs

Akzeptanzkriterien (Pflichtfeld)

  1. Es wurde geprüft, welche Inhalte von den POs und Devs noch zu liefern sind, entsprechend eingefordert und eingearbeitet.
  2. Der Migrationsguide enthält eine Checkliste für die Nutzer.
  3. Alle Bezeichnungen von Umgebungen und APIs sind einheitlich mit der restlichen Dokumentation abgestimmt.
  4. Der Migrationsguide enthält ein Inhaltsverzeichnis.
  5. Im Überblick von der Doku-Seite FIT-Connect 2.0 sind alle Komponenten aufgeführt, die vom Major Release betroffen sind. Zu jeder Komponente existiert ein Beschreibungstext und entsprechenden Patch Notes.
  6. Inhalte/Informationen aus dem Newsletter, der Betriebsankündigung und der OV Nutzendenkreis sowie Technikkreis wurden geprüft und in die Dokumentation eingearbeitet.
  7. Breaking Changes werden hervorgehoben. Es existiert ein eigens Kapitel hierzu.
  8. Zusammenführung von "Allgemeines" und "Major Releases" (Sidebar)
  9. Die Seite Allgemeines erklärt verständlich, was ein Major Release ist bzw. wie wir es bei FIT-Connect definieren.
  10. Hinweise zu Auswirkungen auf bestehende Features und mögliche Anpassungen sind im jeweiligen Abschnitt des Major Releases enthalten.
  11. Die Darstellung ist strukturiert, leicht lesbar und konsistent.
  12. Die neuen SDKs werden in der zugehörigen Version für das Major Release erwähnt und verlinkt.
  13. ...

Mögliche Folgeaktivitäten (vom Entwickler zu ergänzen)

Edited by Maik Böttner