Überarbeitung des Abschnitts „Abkündigungen“
Dokumentationsseiten (Pflichtfeld)
-
Bestehende Dokumentationsseite (https://docs.fitko.de/fit-connect/docs/development/discontinuation) anpassen
User Story
Die Abkündigungspage soll umfassend, übersichtlich und nutzerfreundlich gestaltet werden.
Auf der Landingpage wird eine Timeline-Tabelle angezeigt, die übersichtlich darstellt, wann welche API-Versionen abgekündigt wurden und insb. welche Abkündigung bevorsteht.
Jede Komponente könnte zusätzlich auf einer eigenen Unterseite detailliert beschrieben werden.
Von der Tabelle aus besteht ein direkter Link zu den Detailseiten, auf denen beispielsweise folgende Informationen bereitgestellt werden:
- Ablaufdatum der Unterstützung
- Migrationspfade zu neuen Versionen
- Technische Hinweise oder Breaking Changes
Warum
Diese Anforderung sorgt dafür, dass Nutzerinnen und Nutzer:
- Schnell nachvollziehen, welche Versionen abgekündigt sind oder demnächst abgekündigt werden.
- Leicht auf relevante Detailinformationen zugreifen können, ohne lange suchen zu müssen.
- Migrationsentscheidungen frühzeitig treffen können, um Unterbrechungen zu vermeiden.
- Transparenz und Vertrauen in die API-Strategie des Unternehmens erhalten.
Eine übersichtliche Darstellung reduziert Support-Anfragen, erhöht die Benutzerzufriedenheit und unterstützt die Einhaltung von Release- und Abkündigungsplänen.
Erkenntnis --> Was muss dokumentiert werden? (Pflichtfeld)
Links, Hinweise, Bemerkungen
- Rubrik Abkündigungen Doku-Portal https://docs.fitko.de/fit-connect/docs/development/discontinuation
- Initiative Issue zum Major Release: https://git.fitko.de/fit-connect/planning/-/issues/3291
Infomaterial
Ansprechperson (Pflichtfeld)
- Zuständige PO: BM/PO MBO in Vertretung für PO LEL
- Technische Ansprechperson: BM MBO, AT AHU
Akzeptanzkriterien (Pflichtfeld)
-
Eine Übersicht mit Timeline auf der Landingpage der Abkündigungen ist erstellt -
Jede Komponente ist als Unterseite aufgeführt -
Abkündigungsregelung ist aktualisiert -
...
Mögliche Folgeaktivitäten (vom Entwickler zu ergänzen)
-
... -
... -
... -
Definition of Done was checked.
Edited by Laura Elges
