FEP-Ressourcen
Ressourcen, die im Föderalen Entwicklungsportal veröffentlicht werden, müssen eine Reihe von Aufnahmekriterien erfüllen.
Sind diese Kriterien erfüllt, kann ein Verzeichniseintrag im FEP erstellt werden.
Als Beispiel dient uns der Inhalt der Datei 115.de.md, die zur Behördenrufnummer 115 gehört.
Inhalt der Datei 115.de.md
---
contactInformation:
mail: 115@fitko.de
name: Produktmanagement FITKO
developer:
name: Produktmanagement FITKO
url: https://www.fitko.de/produktmanagement/115
docsUrl: https://www.115.de/fuer-behoerden
icon:
path: public/img/resources/115/Icon_115.png
title: Produkt-Icon 115
name: Behördennummer 115
shortDescription: Die 115 ist die zentrale Anlaufstelle für Verwaltungsfragen aller Art.
tags:
- type:base
- status:production
---
Die 115 ist die zentrale Anlaufstelle für Verwaltungsfragen aller Art. Ob Reisepass, Gewerbeanmeldung oder Wohngeld: Über die bundesweit einheitliche Rufnummer 115 werden die häufigsten Fragen von Bürger:innen und Unternehmen schnell und kostengünstig geklärt. Rund 550 Kommunen, 14 Länder sowie die gesamte Bundesverwaltung nehmen bereits teil.
Nach Umsetzung des Onlinezugangsgesetzes soll die 115 ab 2023 wesentlicher Teil der dann verpflichtenden Online-Verwaltungsleistungen sein. Hierfür werden eine Lotsenfunktion sowie zusätzliche Technologien wie Chatbot und Sprachdialogsystem entwickelt und als zusätzliche Kommunikationswege eröffnet. Die 115 wird Bürger:innen und Unternehmen somit künftig beim Auffinden und Nutzen der Vielzahl an Online-Leistungen unterstützen.
Erläuterungen zur Beispieldatei
Dateiname / Sprachen
Der Dateiname 115.de.md leitet sich ab aus
- dem Slug, welcher zwischen der für die Ressource verantwortlichen Person und dem FEP-Kernteam vereinbart wurde (hier:
115) - einem Sprachkennzeichen
Das FEP unterstützt die Sprachen Deutsch (Sprachkennzeichende) und optional Englisch (Sprachkennzeichenen) - der Dateiendung
.md, die anzeigt, das es sich um eine Datei im Markdown-Format handelt.
Struktur des Dateiinhalts
Wie bereits erwähnt handelt es sich um ein Markdown-Dokument, welches mit einem Front Matter beginnt. Das Front Matter (übersetzt etwa Vorwort) ist ein im Dokument befindlicher Block am Anfang, der zwischen --- steht. Es enthält Meta-Informationen in YAML-Notation. Das FEP nutzt diese Informationen teilweise als darzustellende Information und teilweise für das Layout bzw. die Gestaltung der Darstellung.
Nach dem Front Matter folgt die Beschreibung der Ressource als Markdown-Text.
Elemente im Front Matter
Die nachfolgende Tabelle enthält die Beschreibung aller Elemente, die für das Front Matter verwendet werden können.
| Name | Typ | Default | Beschreibung |
|---|---|---|---|
contactInformation | Objekt | – | Container für zentralen Ansprechpartner für die Ressource |
contactInformation.mail | String (E-Mail) | – | Funktionspostfach für Rückfragen zur Ressource |
contactInformation.name | String | – | Klartextname der verantwortlichen Organisation oder Rolle |
developer | Objekt | – | Angaben zur entwickelnden Organisation |
developer.name | String | – | Verantwortliche Einheit, die Weiterentwicklungen steuert |
developer.url | URL | – | Öffentliche Website der verantwortlichen Stelle |
docsUrl | URL | – | Offizielle Dokumentations- oder Produktseite |
icon | Objekt | – | Definition eines Icons, das im FEP angezeigt wird |
icon.path | String (Pfad) | - | Relativer Pfad zum Icon innerhalb des FEP-Repos |
icon.title | String | – | Alternativtext bzw. Tooltip für das Icon |
name | String | – | Öffentlicher Name der Ressource |
shortDescription | String | – | Kurzbeschreibung, die in Listenansichten im Portal erscheint |
tags | Array aus Objekten | [] | Liste von Status- und Klassifizierungs-Tags |
tags[].label | String | – | Markierung für Sonderfälle; aktuell unterstützt: external (markiert externe Inhalte, Tooltip) |
tags[].type | String | base | Produktkategorie bzw. Filterwert; erlaubt sind api, base, information, kollaboration, software, vorgabe |
tags[].status | String | production | Reifegrad/Status; erlaubt sind development (in Umsetzung) und production (produktiv) |
sourceCodeUrl | URL | – | Verweis auf öffentlichen Quellcode bzw. Repository |
childResources | Array aus Objekten | [] | Verknüpfte Standards oder abhängige Ressourcen |
childResources[].name | String | – | Anzeigename des referenzierten Standards |
childResources[].slug | String | – | Slug des referenzierten Standards |