Skip to content

Epic:: Doku nutzerzentriert gestalten

Warum

Als Nutzer:in der FIT-Connect-Dokumentation möchte ich gezielt auf meine spezifischen Anforderungen zugeschnittene Informationen erhalten, ohne mich durch für mich irrelevante Inhalte navigieren zu müssen.

Aktuell ist die Dokumentation nicht optimal auf unterschiedliche Zielgruppen ausgerichtet, wodurch es für Fachverfahrenshersteller, Entwickler:innen, Anbindungsmanager:innen und Behörden schwieriger ist, relevante Informationen schnell zu finden.

Ziel

  • Erstellung einer zielgruppenorientierten Dokumentation, die spezifisch auf die Bedürfnisse und Anforderungen der Nutzer:innen zugeschnitten sind.
  • Optimierung der Auffindbarkeit und Lesbarkeit durch eine klare Strukturierung der Inhalte.
  • Verbesserung der Nutzerführung und -erfahrung, um typische Anwendungsfälle für jede Zielgruppe gezielt abzubilden.

Links, Hinweise, Bemerkungen

Akzeptanzkriterien

  • Zielgruppen sind klar definiert und jede Persona hat einen eigenen Bereich in der Dokumentation
  • Bestehende Inhalte sind in das neue Format überführt
  • Qualitätssicherung durch interne Reviews und Testlesungen erfolgt
  • Dokumentation wird von ersten Nutzer:innen getestet und für hilfreich befunden
  • MajorReleaseGuide (!1124) · Merge requests · FIT-Connect / Dokumentation · GitLab ist unter Abkündigungen integriert

Folgeaktivitäten @JACOB_WITTE und @Thomas_Alker

Neue Gliederung und Aufbau

  • Neue Gliederung entwerfen und abstimmen @JACOB_WITTE -> Feedbacks für die neue Dokumentation -> #3568

Marketing neu konzipieren

Anbindung überarbeiten

  • Seiten, Checklisten und Anleitungen zu einer zusammenführen @JACOB_WITTE
  • Feedback einsammeln und überarbeiten -> #3568
  1. Dokumentation migrieren @Thomas_Alker und @JACOB_WITTE
  • Branch in Doku migrieren
  • neu entstandene Inhalte migrieren (3 Seiten in Marketing, 2 Seiten in Anbindung, 1 Seite Kontakt) + eine neue Grafik
  • Sidebar und Navbar migrieren
  • neue Seiten AVV und Risiken in sidebar aufnehmen #706
  • Links mit "Preview" URL durch Prod URL tauschen Link auf Einstieg
  • kleinere Änderungen nachziehen -> #3568

nach Abschluss:

  1. Schlussarbeiten
  • Grafiken überarbeiten: Kaputte Grafiken ersetzen, neue Grafiken einbauen, unnötig gewordene Grafiken entfernen?
  • Neue Inhalte durch Marketing überarbeiten lassen @Carmen_Bickhard @Eylem_Duran
  • Physikalische Ordnerstruktur an Aufbau der Webseite orientieren (dient Verbesserung Matomo Daten)
Edited by Jacob Witte