Konzept
Dieses Dokument ist Teil der Anfrage „fitconnect Artefakte“
Föderales Entwicklerportal Anforderungen, Beispiele und Empfehlungen zu einem FIT-Connect Entwicklerportal Version: 0.9 Stand: 10,09,2020
Inhaltsverzeichnis 1 Strategische Ziele des föderalen Entwicklerportals............................3 2 Good Practice Beispiele für Entwicklerportale.....................................3 2.1 GitHub Projektseiten am Beispiel Tensorflow................................................4 2.2 Twitter API Portal.......................................................................................... 5 2.3 VISA Developer Center.................................................................................. 5 2.4 Cisco DevNet................................................................................................ 6 3 Mögliche Funktionen und Angebote des föderalen Entwicklerportals. 8 3.1 Entwickler:innen Dokumentation..................................................................8 3.1.1 API Dokumentation und Software Development Kits ..................................8 3.1.2 Getting Started und How-Tos.......................................................................8 3.1.3 Aufbereitung nach Persona und Anwendungsfällen.....................................9 3.2 Repositories und weiterführende Entwicklerangebote .................................9 3.2.1 Versionierungssystem.................................................................................. 9 3.2.2 Artefakte und Vernetzung von Repositories.................................................9 3.2.3 Sandbox-Umgebungen.................................................................................9 3.3 Kollaboration undNachnutzung.....................................................................9 3.3.1 Repository ................................................................................................... 9 3.3.2 Issuetracker............................................................................................... 10 3.4 Portalfunktionen.......................................................................................... 10 3.4.1 Aktuelle Änderungen................................................................................. 10 3.4.2 Globale Suche............................................................................................ 10 3.4.3 Schlagworte............................................................................................... 10 3.4.4 Redaktionelle Schwerpunkte......................................................................10 4 Empfehlungen für die Umsetzung des föderalen Entwicklerportals. .10 4.1 Professionelle Redaktions- und Supportstrukturen.....................................10 4.2 Föderale Arbeitsstrukturen und Standards für Entwickler:innen.................11 4.3 Entwicklerfokussierung als Erfolgsfaktor....................................................11 Föderales Entwicklerportal Stand: 10,09,2020 S. 2 von 11
1 Strategische Ziele des föderalen Entwicklerportals Das föderale Entwicklerportal soll alle Implementierungsinformationen zur technischen Übertragung eines Antrags vom Online-Formular zur zuständigen Behörde und auch die digitale Kommunikation zurück zur/zum Antragssteller:in in einer Informationsquelle bündeln. Entwickler:innen finden hier eine vollständige und frei verfügbare Dokumentation von zentralen FIT-Connect Angeboten (wie bspw. Zustelldienst) und weiteren für die Antragsdigitalisierung relevanten Basisdiensten in Bund und Ländern wie bspw. Nutzerkonten, Postfächern, E-Payment Diensten oder Zuständigkeitsfindern. Hiermit soll folgendes Ziel erreicht werden: Das Entwicklerportal unterstützt Entwicklungsteams dabei, Antragsverfahren effizient zu digitalisieren, in dem hier alle wesentlichen Komponenten umfassend dokumentiert sind und Richtlinien zur Implementierung gegeben werden. Dazu werden im Portal drei wesentliche Funktionen gebündelt: 1. Dokumentationen zur Anbindung von Komponenten, Testinfrastrukturen und Nutzungsrichtlinien für Entwickler:innen 2. Repositories für wiederverwendbare Quellcodes und Artefakte und Bereitstellung von Testumgebungen 3. Vernetzung von Entwicklungsteams und Lösungsanbietern Das Portal verknüpft Informationen in diesen drei Bereichen durch eine einheitliche Verschlagwortung, globale Suche und entwicklungsfreundliche redaktionelle Aufbereitung von Themen. Als zentrale Informationsplattform dient das Entwicklerportal auch als „Single-Point-of-Truth“, bspw. bei der Erstellung von Ausschreibungen und in der Kommunikation mit Bietenden oder bei der Planung behördeninterner IT-Architektur für das Antragsmanagement. 2 Good Practice Beispiele für Entwicklerportale In Vorbereitung zu den Arbeiten am Konzept des föderalen Entwicklerportals wurden bestehende Entwicklerportale betrachtet, um Anregungen für das FIT- Connect Entwicklerportal zu gewinnen und den möglichen Umfang eines föderalen Entwicklerportals zu evaluieren. Föderales Entwicklerportal Fehler! Verwenden Sie die Registerkarte 'Start', um Überschrift 1;Überschrift 1 (FITKO) dem Text zuzuweisen, der hier angezeigt werden soll. Stand: 03.09.2020 S. 3 von 11
2.1 GitHub Projektseiten am Beispiel Tensorflow Beschreibung: GitHub Projektseiten sind de facto die Standard Plattform für OpenSource Projekte. Im Mittelpunkt der Plattform steht das git Versionierungssystem. Daneben bietet GitHub aber auch viele geforderte Funktionen wie CMS, Issue Tracker und User Management. Als ein Beispiel für eine gut dokumentierte und gepflegte Projektseite kann Tensorflow (Open Source Machine Leaning Plattform) gesehen werden: Abbildung 1Startseite des Tensorflow GitHub Repositories (https://github.com/tensorflow) Erkenntnis GitHub bietet zwar viel vom benötigten Funktionsumfang, aber die Aufbereitung der Informationen entspricht im Allgemeinen nicht dem für FIT-Connect angestrebten Standard. GitHub und andere git-basierte Projektseiten (bspw. GitLab oder Gitea) können somit nur als Minimalstandard herangezogen werden und sind eher ein Teilbereich eines föderalen Entwicklerportals. So besitzt bspw. Tensorflow neben Föderales Entwicklerportal Fehler! Verwenden Sie die Registerkarte 'Start', um Überschrift 1;Überschrift 1 (FITKO) dem Text zuzuweisen, der hier angezeigt werden soll. Stand: 03.09.2020 S. 4 von 11
der Projektseite auf GitHub noch eine eigenständige Entwicklerseite (https://www.tensorflow.org/) mit Informationen zur Nutzung von Tensorflow. 2.2 Twitter API Portal Beschreibung: Hierbei handelt es sich um eine Dokumentation einer im Umfang relativ begrenzten Schnittstelle und eines abgeschlossenen Öko-Systems. Die Schnittstelle wird für den Zugang aus vielen verschiedenen Anwendungsfällen betrachtet, um den Einstieg in die Nutzung der Twitter-API zu erleichtern. Abbildung 2 Startseite des Twitter API Portals (https://developer.twitter.com) Erkenntnis: Die Dokumentation der Schnittstelle ist vorbildlich, genau wie die Aufbereitung für spezielle Anwender:innen Personas und ihre Anwendungsfälle. Allerdings ist die Plattform im Umfang begrenzter, als der Fokus der föderalen Entwicklerplattform bei FIT-Connect, da dieser mehr als eine reine API- Dokumentation liefern will. Föderales Entwicklerportal Fehler! Verwenden Sie die Registerkarte 'Start', um Überschrift 1;Überschrift 1 (FITKO) dem Text zuzuweisen, der hier angezeigt werden soll. Stand: 03.09.2020 S. 5 von 11
2.3 VISA Developer Center Beschreibung: Entwicklerportal als Einstieg in eine Vielzahl von VISA APIs. Aufbereitung von Use- Cases und Fallbeispielen. Das Entwicklerportal bietet Community Funktionen, Globale Suche und stellt Referenz-Implementierungen bereit, an der sich Entwickler:innen orientieren können. Abbildung 3 Startseite des VISA Developer Center (https://developer.visa.com) Erkenntnis: Das VISA Entwicklerportal ist hinsichtlich des Umfangs und der Problemstellung mit dem FIT-Connect Fall vergleichbar. Die Aufbereitung und grundsätzliche Benutzerführung ist vorbildlich und sollte im Laufe des FIT-Connect Aufbaus weiter evaluiert werden. 2.4 Cisco DevNet Beschreibung: Föderales Entwicklerportal Fehler! Verwenden Sie die Registerkarte 'Start', um Überschrift 1;Überschrift 1 (FITKO) dem Text zuzuweisen, der hier angezeigt werden soll. Stand: 03.09.2020 S. 6 von 11
Cisco DevNet ist eine Dokumentationsplattform eines Hard- und Softwareherstellers. Sie bietet einen großen Umfang an dokumentierten Produkten und Schnittstellen. Dementsprechend ist die Plattform weit verzweigt in einer tiefen Navigationsstruktur. Abbildung 4 Start Seite des Cisco DevNet Portals (https://developer.cisco.com) Erkenntnis: Bei Cisco fallen vor allem die Onboarding Angebote, die Community und Austauschfunktionen positiv auf: Alle Entwicklungsressourcen sind grundsätzlich nach Themen-, Funktions- und Produktbereichen von CISCO geordnet, Für Entwickler:innen stehen für alle Entwicklungsthemen sowohl komplette E-Learning Tracks wie auch ein Angebot von videobasierten Kursen zur Verfügung, Für viele Entwicklungsaufgaben werden kostenlose Sandbox Umgebungen zum Testen eigener Lösungen gelistet, die komfortabel über das Portal aufgefundenund beantragt werden können. Föderales Entwicklerportal Fehler! Verwenden Sie die Registerkarte 'Start', um Überschrift 1;Überschrift 1 (FITKO) dem Text zuzuweisen, der hier angezeigt werden soll. Stand: 03.09.2020 S. 7 von 11
Das Portal bietet ein redaktionell aufbereitetes Verzeichnis von Code Repositories, über das sowohl CISCO-eigene Lösungen als auch CISCO Plattform fokussierte Lösungen von anderen Entwickler:innen gefunden werden können. Das Cisco DevNet ist von allen betrachteten Entwicklerportalen das am weitesten entwickelte Portal, sowohl hinsichtlich der Professionalität als auch des Umfangs der Entwicklerangebote. Für die Planung von FIT-Connect bietet das Portal einen langfristigen Entwicklungsrahmen für neue Funktionen und Angebote. Eine vergleichbare Umsetzung und Qualität ist allerdings mit einem sehr hohen Aufwand verbunden. 3 Mögliche Funktionen und Angebote des föderalen Entwicklerportals Gemäß den strategischen Zielstellungen und den betrachteten Beispielen für Entwicklerportale wurden einige erste grundlegende Funktionen und Angebote identifiziert, die ein föderales Entwicklerportal anbieten müsste. 3.1 Entwickler:innen Dokumentation 3.1.1 API Dokumentation und Software Development Kits In erster Linie dokumentiert das Entwicklerportal die Schnittstellen von FIT- Connect Komponenten und anderen föderalen Basisdiensten, die im Rahmen des digitalen Antragsmanagement in der föderalen Landschaft einzubinden sind. API Dokumentationen sollten grundsätzlich eine sehr hohe Qualität haben. Zudem sollte die Möglichkeit bestehen, diese konstant durch den Austausch mit den Entwickler:innen weiterentwickelt zu können, sodass unabhängige Entwickler:innen eigenständig Implementierungen realisieren können, ohne auf zusätzliches Wissen zurückgreifen zu müssen. Software Development Kits und Client Libraries, die im Rahmen von FIT-Connect und anderen Akteur:innen entwickelt werden, werden ebenfalls im Entwicklerportal offen dokumentiert und bereitgestellt. 3.1.2 Getting Started und How-Tos Neben den Referenzinhalten werden im Portal Informationen gesammelt, die Entwickler:innen beim Onboarding und der Planung von Digitalisierungsprojekten helfen. Für den erleichterten Einstieg in die Umsetzung von Verfahren mit FIT- Connect werden „Getting Started“-Artikel verfasst. Erfahrungen aus laufenden und abgeschlossenen Projekten können als Best-Practices in Form von Blogs oder Artikeln weitergegeben werden. Basiswissen zu Themen wie z. B. Ende-zu-Ende Föderales Entwicklerportal Fehler! Verwenden Sie die Registerkarte 'Start', um Überschrift 1;Überschrift 1 (FITKO) dem Text zuzuweisen, der hier angezeigt werden soll. Stand: 03.09.2020 S. 8 von 11
Verschlüsselung wird in einer "Knowledge Base" zusammengetragen und bereitgestellt . Für die Implementierungen interoperabler Lösungen können E-Learning Angebote produziert und bereitgestellt werden. 3.1.3 Aufbereitung nach Persona und Anwendungsfällen Für den erleichterten Einstieg in die Nutzung von Basiskomponenten und Entwicklungsartefakten werden Informationen und Ressourcen anhand von Persona- und Anwendungsfällen zusammengestellt. Mit solchen Inhalten können Fragen wie „Ich bin Fachverfahrensentwickler:in und interessiere mich für Antragsübermittlung und Rückkanal“ beantwortet werden. 3.2 Repositories und weiterführende Entwicklerangebote 3.2.1 Versionierungssystem Für OpenSource Projekte wie ggf. den zentralen Zustelldienst stellt das Entwicklerportal ein git-Repository für die Community-Entwicklung bereit. Für zentrale Komponenten wird die Software-Governance durch Moderator:innen und Pull-Requests gewährleistet. Das Repository kann auch für die gemeinsame Lösungsentwicklung zwischen Entwicklungsteams genutzt werden. 3.2.2 Artefakte und Vernetzung von Repositories Neben dem Code Repository werden im Entwicklerportal auch Ressourcen wie UI Kits, Regelwerke und Schemata zum Download angeboten oder auf bestehende Repositories (Bspw. XRepository oder FIM-Repository) verwiesen. Entwickler:innen-Teams können über das Entwicklerportal, bspw. über die Einbindung eigener Repositories oder FIT-Connect eigener Repositories, Artefakte zur Wiederverwendung durch andere Projekte bereitstellen. 3.2.3 Sandbox-Umgebungen Zum Testen eigener Implementierungen können Entwickler:innen-Teams über das Entwicklerportal Zugang zu Sandbox-Umgebungen als Gegenstellen für ihre Test-Infrastruktur anfordern, um Anwendungsszenarien einfach zu simulieren. Föderales Entwicklerportal Fehler! Verwenden Sie die Registerkarte 'Start', um Überschrift 1;Überschrift 1 (FITKO) dem Text zuzuweisen, der hier angezeigt werden soll. Stand: 03.09.2020 S. 9 von 11
3.3 Kollaboration und Nachnutzung 3.3.1 Repository Die oben beschriebenen Repository-Funktionen können von Implementierungsteams verwendet werden, um eigene Lösungen zur weiteren Nutzung durch andere Teams zu veröffentlichen. In Kombinationen mit den redaktionellen Möglichkeiten des Entwicklerportals bietet sich hier ein hohes Potential der Nachnutzung von Entwicklungen, wenn die Lösungen entsprechend aufbereitet und im Portal kommuniziert werden. Das Repository erlaubt grundsätzlich jedem, Fehlerbehebungen und Verbesserungen zu einem Projekt beizutragen. 3.3.2 Issuetracker Support- und Service- Anfragen für die FIT-Connect Komponenten werden durch einen Issuetracker abgebildet. 3.4 Portalfunktionen Das Portal verbindet die oben genannten Bereiche mit globalen Funktionen wie bspw. einer Suche, letzte Änderungen, Hervorhebung aktuellen Informationsschwerpunkte. Der Einstieg in die Nutzung von FIT-Connect wird durch Landingpages und die Verknüpfung von ansonsten verteilten Informationen wesentlich erleichtert. 3.4.1 Aktuelle Änderungen Das Entwicklerportal bietet zentrale Informationsdienste für Entwickler:innen zu laufenden Änderungen an Standards, Schnittstellen und Infrastrukturen. 3.4.2 Globale Suche Über die oben genannten Bereiche Dokumentation, Repository und Kollaborationsinhalte wird ein Suchindex erstellt, der eine globale Suche ermöglicht. 3.4.3 Schlagworte Informationen werden durch einen einheitlichen Schlagwortindex verknüpft. D. h. zum Schlagwort „Nutzerkonto“ finden sich sowohl hilfreiche Artikel und Spezifikationen als auch Codebeispiele und wiederverwendbare Implementationen. Föderales Entwicklerportal Fehler! Verwenden Sie die Registerkarte 'Start', um Überschrift 1;Überschrift 1 (FITKO) dem Text zuzuweisen, der hier angezeigt werden soll. Stand: 03.09.2020 S. 10 von 11
