Zum Hauptinhalt springen

Überblick

Vielen Dank für Ihr Interesse am Föderalen Entwicklungsportal (FEP), einem Produkt des IT-Planungsrats. Auf den folgenden Seiten erläutern wir, wie Inhalte wie Dokumentationen, API-Spezifikationen, Richtlinien und Implementierungsbeispiele im Föderalen Entwicklungsportal erstellt, gepflegt und veröffentlicht werden.

Aufbau des Föderalen Entwicklungsportals​

Übersichtsschema Föderales Entwicklungsportal
Erklärtext zur Infografik

Das Portal​

Der Bereich oberhalb der Trennlinie stellt das Portal dar. Der Inhalt des Portals besteht aus:

  • Verzeichniseinträgen für Entwicklungsressourcen
  • Verzeichniseinträgen für FIT-Standards

Das Portal ist das zentrale Verzeichnis für technische Ressourcen und Föderale IT-Standards (FIT-Standards) der öffentlichen Verwaltung in Deutschland.
Es fungiert als Wegweiser, der Entwickler, Architekten und Projektverantwortliche schnell und zuverlässig zu den Websites für spezifische Produkte, Technologien und Standards führt.

Die Kernfunktionen des Portals sind somit:

  1. Zentraler Zugang zu allen relevanten Ressourcen Bündelt FIT-Standards, technische Dokumentationen und Referenzlösungen der öffentlichen IT in Deutschland.
    → Keine aufwendige Suche über verschiedene Quellen – alles an einem Ort.

  2. Effiziente Recherche für präzise Dokumentation Schnelle Auffindbarkeit von aktualisierten Standards, Vorlagen und Best Practices.
    → Spart Zeit bei der Erstellung und Pflege von Dokumentationen.

  3. Förderung der Wiederverwendung und Konsistenz Bereitstellung geprüfter Lösungen und Formate zur Nachnutzung.
    → Vermeidet Doppelarbeit, sichert Interoperabilität und gewährleistet Einheitlichkeit.

Beim Portal handelt es sich um eine moderne Next.js Anwendung. Der Quellcode steht auf openCode zur Verfügung.

Dokumentationswebsites für spezifische Produkte​

Spezifische Produkte, Technologien und Standards verfügen regelmäßig über eine eigenständige Dokumentation. Solche Dokumentationen sind im unteren Bereich der Grafik angedeutet.

Im Rahmen des FEP bietet es sich an, diese Dokumentationen auf Basis des Static-Site-Generators Docusaurus zu erstellen. Diese Dokumentation enthält dazu mit dem Redaktions-Handbuch einen zentralen Leitfaden
Docusaurus erzeugt mittels einer GitLab CI/Pipeline eine statische Website aus einer Sammlung von Markdown-Files. Derartige Dokumentationswebsites werden ebenfalls in einem Gitlab-Repository verwaltet und auf docs.fitko.de veröffentlicht.

Hier einige Beispiele für existierenden Dokumentationswebsites:

DokumentationWebsiteGitlab Repository
Dokumentation zur Deutschen Verwaltungscloud (DVC)WebsiteRepository
Dokumentation zur Föderalen IT-ArchitekturWebsiteRepository
Föderales Informationsmanagement (FIM)WebsiteRepository

Erstellen von Inhalten​

Im Rahmen der Inhaltserstellung ist zu unterscheiden zwischen

  • Verzeichniseintrag im FEP für eine Entwicklungsressource
    Alle Entwicklungsressourcen auf einen Blick
    Diese Einträge werden vom FEP-Kernteam gepflegt und mit dem Produktmanagement der jeweiligen Ressource abgestimmt.
    Weitere Informationen dazu finden Sie auf der Seite FEP-Ressourcen.

  • Verzeichniseintrag im FEP für einen FIT-Standard
    Die FIT-Standards im Überblick
    Diese Einträge werden durch die Geschäftsstelle des FIT-Standardisierungsboards in Abstimmung mit den Verantwortlichen des jeweiligen FIT-Standards gepflegt. Bei Fragen hierzu senden Sie eine E-Mail an it‑standards@fitko.de.

  • Dokumentationswebsites
    Das jeweilige Produktmanagement verantwortet Struktur, Inhalte und fortlaufende Pflege jeder Dokumentationswebsite. Zur Orientierung steht das Redaktions-Handbuch zur Verfügung. Es ist entlang typischer Arbeitsschritte gegliedert:

Kontakt​

Bei Fragen zum Föderalen Entwicklungsportal oder für inhaltliche Rückmeldungen kontaktieren Sie bitte das FEP-Team der FITKO über den Issue-Tracker oder senden Sie einfach eine E-Mail an FEP@FITKO.de.