Skip to content

Analyse Struktur & Konsistenz der Dokumentation

Warum?

Als Softwareentwickler:in oder als Verfahrensverantwortliche:r möchte ich einen leichten Einstieg in die Dokumentation finden, um alle relevaten Informationen schnell aufzufinden und direkt mit der Entwicklung mit FIT-Connect starten zu können.

Zielgruppen der Dokumentation sind:

  1. Softwareentwickler:innen
  2. Verfahrensverantwortliche / Betriebsverantwortliche
  3. IT-Architekten aus Bund, Ländern und Kommunen (nachrangig)

Relevante Links und Bemerkungen

Zu prüfende Kriterien:

  1. Die Struktur der Inhalte (Seiten- und Top-Navigation) ist konsistent und ermöglicht es allen Zielgruppen, zügig alle für Sie relevanten Infos zu finden. Dabei werden sie von der Struktur der Dokumentation "an die Hand genommen" und durch die für sie relevanten Infos geführt. -> #494 (closed)
  2. Informationen aus FAQ-Einträgen sind, sofern sinnvoll, in der Dokumentation enthalten. -> #552 (closed)
  3. Es existieren sinnvolle Querverweise zwischen den Unterseiten.
  4. Alle beschriebenen Sachverhalte werden vollständig beschrieben.
  5. Es fehlen keine für die Nutzung von FIT-Connect relevanten Infos.
  6. Es gibt Grundlagenartikel, die die genutzten Technologien & Standards (z.B. hybride Verschlüsselung, JOSE-Standard, OAuth, ...) vorstellen und ggf. auf weiterführende (externe) Ressourcen verlinken.
  7. Alle enthaltenenen Beispiele sind vollständig. Es fehlen keine Beispiele. -> #70 und -> #550 (closed)
  8. Die Code-Beispiele der verschiedenen Sprachen stimmen inhaltlich überein.

Akzeptanzkriterien

  1. Für alle zu prüfenden Kriterien wurden Erkenntnisse
    • in diesem Issue dokumentiert oder
    • bereits in einem (in diesem Issue verlinkten) Merge-Request behandelt, wenn es sich im kleinere Todos (<15min) handelt, oder
    • in einem (ggf. neu erstellten) Follow-Up-Issue adressiert.
  2. Für alle in diesem Issue dokumentierten Erkenntnisse gibt ein oder mehrere Follow-Up-Issues.

Durchführungsplan (vom Entwickler bei Storyplanung auszufüllen)

Edited by Michael Haidner