Zum Hauptinhalt springen

Aufnahmekriterien

Gemäß Beschluss 2020/44 (öffnet in neuem Tab) des IT-Planungsrates soll das föderale Entwicklungsportal für alle relevanten Produkte und föderalen Basiskomponenten die benötigten technischen Dokumentationen, Entwicklungsressourcen und Leitfäden bedarfsorientiert bündeln und offen bereitstellen.

Ressourcen, die im Föderalen Entwicklungsportal veröffentlicht werden, müssen eine Reihe von Aufnahmekriterien erfüllen. Diese gemeinsamen Mindeststandards an Qualität und Offenheit von Entwicklungsressourcen dienen der Gewährleistung eines einheitlichen, hohen Qualitätsniveaus der bereitgestellten Artefakte. Die Kriterien können daher auch als allgemeine Checkliste bei der Entwicklung von Software, APIs und Dokumentation verstanden werden.

Aktuelle Version

Derzeit liegen die Aufnahmekriterien in der Version 0.3.0 vor.

Allgemeine Kriterien

  • A.1: Die Ressource weist einen Bezug zu den Produkten und Standards des IT-Planungsrat (öffnet in neuem Tab), zu Building Blocks der EU-Kommission (öffnet in neuem Tab) oder zu offiziellen Basisdiensten der öffentlichen Verwaltung auf oder stellt eine nützliche Ressource zur effizienten Digitalisierung von Verwaltungsleistungen dar.
  • A.2: Die Ressource erzeugt keine Lock-in-Effekte zu einzelnen Anbietern. Dies ist z.B. dann der Fall, wenn die Ressource unter einer freien Softwarelizenz (Open-Source-Lizenz) bereitsteht und keine Abhängigkeiten zu konkreten, herstellerspezifischen Produkten aufweist.

Kriterien für Dokumentation / Textressourcen

  • D.1: Die Dokumentation liegt als verlinkbare Webseite vor. Insbesondere liegt die Dokumentation nicht ausschließlich als PDF vor. Für einfache Softwareartefakte kann dabei eine im Code-Repository enthaltene Dokumentation in Form von Markdown- oder AsciiDoc-Dateien ausreichend sein.

Kriterien für Softwareartefakte

Kriterien für API-Spezifikationen

Die Aufnahmekriterien werden fortlaufend aktualisiert.