Handbuch
Dieses Handbuch erläutert die wichtigsten Funktionen der I14Y-Interoperabilitätsplattform. Es beinhaltet zahlreiche Schritt-für-Schritt-Anleitungen. Zusätzlich bietet es Angaben zu technischen Details sowie Hintergrundinformationen zur Harmonisierung und Standardisierung von Daten.
In einem ersten Kapitel werden die Rollen und Prozesse in der Datenbewirtschaftung beleuchtet. Unter Metadaten abrufen werden Wege zum Bezug von Informationen von der I14Y-Interoperabilitätsplattform aufgezeigt. Im darauf folgenden Kapitel Metadaten publizieren wird erläutert, wie Beschreibungen von Datensammlungen, elektronischen Schnittstellen und Datenelementen auf der Plattform veröffentlicht werden. Zudem wird gezeigt, wie das Verzeichnis der Behördenleistungen befüllt wird.
Das Handbuch enthält zudem ein Glossar mit Fachbegriffen, eine Liste mit Weblinks, eine Übersicht über die Partnerorganisationen sowie ein Log mit den wichtigsten Änderungen, die an der Plattform vorgenommen wurden.
Die Funktionalitäten der I14Y-Interoperabilitätsplattform werden laufend ausgebaut. Auch dieses Handbuch wird regelmässig überarbeitet. Haben Sie Anregungen, wie es verbessert werden könnte? Oder möchten Sie die Erfahrungen, die Sie mit dem Handbuch oder der Plattform gemacht haben, mit uns teilen? Schreiben Sie uns. Dieses Handbuch wird auf der Codeverwaltungsplattform Github gepflegt. Gerne können Sie dort einen Pull-Request mit Ihren Änderungswünschen einreichen.
So reichen Sie einen Pull-Request ein
Das I14Y-Handbuch ist in einer Auszeichnungssprache – englisch: Markup Language – verfasst. Die Software Hugo wandelt die Textdaten in eine Website um. Die Inhalte dieses Handbuchs werden auf der Codeverwaltungsplattform GitHub gepflegt. Dort lassen sich Änderungsvorschläge erfassen und einreichen. Das funktioniert mit dem normalen Git-Workflow (Branch erstellen, einreichen per Pull Request ). Oder aber: direkt im Webbrowser gemäss der folgenden Kurzanleitung.
- Erstellen Sie ein Konto auf der Codeverwaltungsplattform Github. Loggen Sie sich ein.
- Öffnen Sie das Repository mit dem Handbuch. Die Textinhalte befinden sich im Verzeichnis content, unterteilt nach Sprache, Kapitel und Unterkapitel. Dateien mit der Endung .md enthalten die eigentlichen Textinhalte sowie die Grafiken. Suchen Sie den anzupassenden Textteil. Lassen Sie sich den Rohtext anzeigen.
- Klicken Sie zum Bearbeiten auf das Bleistiftsymbol oben rechts. Nehmen Sie die nötigen Änderungen vor. Beachten Sie dabei die Markup-Syntax-Regeln.
- Beschreiben Sie im Formular unter dem Text die Änderung kurz. Reichen Sie den Vorschlag anschliessend mit einem Klick auf den Knopf ein. Ihr Vorschlag wird zeitnah vom I14Y-Team geprüft und allenfalls ins Handbuch integriert.