Epic: Umgestaltung der Navigationsleiste

Dokumentationsseiten (Pflichtfeld)

  • Neue Dokumentationsseite
  • Bestehende Dokumentationsseite (Link: ) anpassen

User Story

Als Dokumentationsteam trennen wir die Dokumentation in einen Anbindungs- und einen Entwicklerbereich auf. Diese zwei Bereiche erfüllen die jeweiligen Bedürfnisse dier Zielgruppen indem sie unterschiedliche Flugebenen einnehmen. Dafür muss die Navigationsbar umgestaltet werden und durchgängig die verschiedenen Seiten in den jeweiligen Bereichen anzeigen.

Warum

Entwickler:innen benötigen tiefergehende Informationen und sind später im Anbindungsprozess vorzufinden. Diese Informationen können Personen welche auf einer ersten höheren Flugebene vorhanden sind verwirren. Daher werden die Bereiche getrennt.

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

Links, Hinweise, Bemerkungen

##**Übersicht alle Dokumentationsfelder (https://git.fitko.de/fit-connect/docs/-/blob/main/sidebar.js?ref_type=heads) **

/**

  • Überarbeitete Sidebar-Struktur für FIT-Connect Dokumentation
  • Ziel: Stabilität, klare Navigation, konsistente Darstellung */

` module.exports = { // =============================== // Start / Einführung // =============================== defaultSidebar: [ { type: 'doc', id: 'intro', label: 'Einführung in FIT-Connect' } ],

// =============================== // ANBINDUNGSDOKUMENTATION // =============================== anbindungSidebar: [ { type: 'category', label: 'Einführung & Nutzung', collapsed: false, items: [ 'intro', 'use_cases/sender', 'use_cases/receiver', 'organisation-tasks/Anbindungskatalog', 'organisation-tasks/success-stories' ] }, { type: 'category', label: 'Für Entscheider:innen', collapsed: true, items: [ 'organisation-tasks/video-entscheider', 'organisation-tasks/bidiko-entscheider', 'organisation-tasks/buergerpostfach-entscheider' ] }, { type: 'category', label: 'Für Verantwortliche', collapsed: true, items: [ { type: 'category', label: 'Leitfäden zur Anbindung', items: [ 'organisation-tasks/leitfaden-onlinedienst-ueberblick', 'organisation-tasks/sender', 'organisation-tasks/leitfaden-fachverfahren-ueberblick', 'organisation-tasks/subscriber', 'organisation-tasks/leitfaden-unternehmen-ueberblick', 'organisation-tasks/zbp-anbindung' ] }, { type: 'category', label: 'Behörden & Verwaltung', items: [ 'organisation-tasks/certificates', 'organisation-tasks/jwks-erzeugen', 'organisation-tasks/routing' ] }, { type: 'category', label: 'Nutzung & Verwaltung', items: [ 'getting-started/elster-login', 'getting-started/user-verwalten' ] }, { type: 'category', label: 'Rechtsgrundlagen', items: [ 'details/responsible-disclosure', 'details/terms-of-use-prod', 'details/avv', 'details/privacy-policy-ssp' ] }, 'organisation-tasks/bidiko-verantwortliche' ] }, { type: 'category', label: 'Updates & Major Releases', collapsed: true, items: [ 'major-release/allgemeine_informationen', 'major-release/fit-connect_2_0/ueberblick', 'major-release/fit-connect_2_0/migration_guide_2_0', 'major-release/fit-connect_2_0/faq' ] }, { type: 'category', label: 'Mediathek & Materialien', collapsed: true, items: [ 'mediathek/videos_fuer_entscheider', 'mediathek/videos_fuer_verantwortliche', 'mediathek/videos_fuer_entwickler', 'mediathek/documents', 'mediathek/pressesammlung' ] }, { type: 'category', label: 'Kontakt & Service', collapsed: true, items: [ 'contact/contact', 'contact/newsletter', 'contact/impressum' ] } ],

// =============================== // ENTWICKLERDOKUMENTATION // =============================== entwicklerSidebar: [ { type: 'category', label: 'Einstieg & Grundlagen', collapsed: false, items: [ 'getting-started/get-started', 'getting-started/user-journey', 'getting-started/environments', 'getting-started/schema-validation', 'getting-started/notifications-and-deletion-deadlines', 'getting-started/limits', 'details/crypto', 'status-and-error-codes' ] }, { type: 'category', label: 'Aufbau einer Einreichung', collapsed: true, items: [ 'getting-started/submission/structure', 'metadata/overview', 'metadata/contentStructure', 'metadata/absenderinformationen', 'metadata/authenticationInformation', 'metadata/paymentInformation', 'metadata/replyChannel', 'metadata/additionalReferenceInfo', 'metadata/beispiel-metadata' ] }, { type: 'category', label: 'Rückkanal & Eventlog', collapsed: true, items: [ 'reply-channels/overview', 'reply-channels/einstellungen-empfaenger', 'reply-channels/einstellungen-sender', 'reply-channels/reply-events', 'getting-started/event-log/overview', 'getting-started/event-log/events', 'getting-started/event-log/get-events', 'getting-started/event-log/set-creation', 'getting-started/event-log/set-validation' ] }, { type: 'category', label: 'APIs & SDKs', collapsed: true, items: [ 'apis/submission-api', 'apis/routing-api', 'apis/destination-api', 'sdks/overview', { type: 'category', label: '.NET SDK', items: [ 'sdks/net-sdk/overview', 'sdks/net-sdk/sender', 'sdks/net-sdk/receiver', 'sdks/net-sdk/destination', 'sdks/net-sdk/changelog' ] }, { type: 'category', label: 'Java SDK', items: [ 'sdks/java-sdk/overview', 'sdks/java-sdk/sender', 'sdks/java-sdk/receiver', 'sdks/java-sdk/changelog' ] }, { type: 'category', label: 'JavaScript SDK', items: [ 'sdks/javascript-sdk/overview', 'sdks/javascript-sdk/changelog' ] } ] }, { type: 'category', label: 'Integration & Leitfäden', collapsed: true, items: [ 'leitfaeden/integration-guide-sender', 'leitfaeden/integration-guide-subscriber', 'getting-started/account', 'getting-started/authentication', 'receiving/destination', 'details/callbacks', 'details/ars' ] }, 'zbp/zbp', 'development/discontinuation', 'roadmap', 'glossary' ] } `

Zusammenfassung:

Kategorie Hauptzielgruppe Fokus Beispielinhalt
Anbindungsdokumentation Organisationen, Verwaltungen, Hersteller Fachliche & organisatorische Nutzung Leitfäden, Verträge, Rechtsgrundlagen
Entwicklerdokumentation Entwickler:innen, IT-Integratoren Technische Integration, APIs, SDKs REST-API, Encryption, Event Logs

Ansprechperson (Pflichtfeld)

  • Zuständige PO:
  • Technische Ansprechperson:

Akzeptanzkriterien (Pflichtfeld)

  1. Navbar Anpassung für Entwicklerdoku und Anbindungsdoku
  2. Neue Struktur wird genutzt Designs | Ebene | Titel | |-------|-------| | 1 | Homepage | | 2 | Anbindung | | 2.1 | Informationen | | 2.2 | Anbindung | | 2.2 | Anbindung | | 2. ... | TBD | | 3 | Entwicklung | | 3.1 | Getting started | | 3.2 | API | | 3.3 | SDK | | 3.4 | Changelog | | 3.5 | Abkündigungen | | 3. .... | (API)TBD) | | 4 | ... (TBD) |

image 5. [ ] Matomo wird angepasst 6. [ ] die Sidebar in GitLab neu gegliedert, sodass diese der Aufstellung von der Doku entspricht 7. [ ] Anpassung der Links auf den jeweiligen Dokumentationsseiten --> Link-Checker nutzen 8. [ ] Weiterleitungslinks auf den Dokumentationsseiten werden eingeführt 9. [ ] FEP Links anpassen 10. [ ] ...

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

Click to expand ## Dokumentationsseiten (Pflichtfeld) - [x] Neue Dokumentationsseite - [x] Bestehende Dokumentationsseite (Link: ) anpassen

User Story

Als Dokumentationsteam möchten wir verstehen wie mit der Doku umgegangen werden soll.

Wünsche vom Dokuteam:

  • Bedingungen von Versionen abbildbar
  • Mehrfachpflege verhindern
  • Uralt-Issues werden davor aufgearbeitet

Möglichkeiten

  • Separate Dokumentation für Major Version

  • Dokumentationsseite/Untertitel enthält Metadatenversion

  • Tools möglich?

Warum

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

Links, Hinweise, Bemerkungen

Ansprechperson (Pflichtfeld)

  • Zuständige PO:
  • Technische Ansprechperson:

Akzeptanzkriterien (Pflichtfeld)

  1. Labels für die GitLab Tickets, sodass zuordenbar ist zu welchem Metadatensatz die Anforderung ist
  2. Navbar Anpassung für Entwicklerdoku und Anbindungsdoku
  3. Entwicklerdoku erhält Versionierung
  4. Entwicklerdoku wird schlanker gestaltet
  5. Neue Struktur wird genutzt image
  6. Matomo wird angepasst
  7. Allgemein wird die Sidebar in GitLab neu gegliedert, sodass diese der Aufstellung von der Doku entspricht
  8. ...

Ablaufplan

Parallel ganz am Anfang: Instanz 1 und 2 werden erstellt von Jacob und Andreas H.

Parallel laufen Marketing und Entwicklung los:

  1. Gliederung wird von Jacob angepasst
  2. Elmar und Jacob gehen Seiten mit Hilfe von Storytelling durch (aka Verschlankung)
  3. Sidebar wird in GitLab wird angepasst
  4. Hans und jeweilige Team geht Entwicklerdoku durch für Verschlankung

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

Edited by Laura Elges