Handbuch

Dieses Handbuch erläutert die wichtigsten Funktionen der Interoperabilitätsplattform I14Y. Es dient neuen Nutzerinnen und Nutzern als Einführung in die Plattform und ihre Funktionsweise. Erfahrene Personen können es als Referenz nutzen, um gezielt Informationen zu einzelnen Funktionen, Prozessen und Begriffen nachzuschlagen. Das Handbuch dokumentiert möglichst vollständig, wie die verschiedenen Funktionalitäten von I14Y genutzt werden können und welche Überlegungen dahinterstehen. Es beschreibt die Prinzipien der Harmonisierung und Standardisierung von Daten, die Rollen und Zuständigkeiten in der Datenbewirtschaftung sowie die Logik hinter den einzelnen Erfassungs- und Publikationsprozessen.

Das Umfeld in der Datenbewirtschaftung ist dynamisch. Anforderungen, Standards, technische Möglichkeiten und organisatorische Abläufe entwickeln sich laufend weiter. Umso wichtiger ist eine gemeinsame Wissensbasis, die Orientierung schafft, häufige Fragen beantwortet und bewährte Vorgehensweisen festhält. Dieses Handbuch soll dazu beitragen, dass Wissen nicht nur punktuell vorhanden ist, sondern für alle Beteiligten nachvollziehbar, zugänglich und weiterentwickelbar bleibt.

Mitmachen erwünscht

Lassen Sie Ihr eigenes Know-how und Ihre eigenen Erfahrungen einfliessen. Das Handbuch soll ein lebendiger Text sein, der mit den Erfahrungen der Nutzerinnen und Nutzer mitwächst. Ergänzen Sie, wenn im Handbuch etwas fehlt. Präzisieren Sie, wenn etwas unklar ist. Und schildern Sie Vorgehensweisen, die sich in der Praxis bewährt haben. Wir freuen uns auf Ihre Beiträge.

Die Beteiligung an diesem Handbuch ist einfach: Beiträge können per E-Mail eingereicht oder direkt im Text vorgeschlagen werden. Die Inhalte werden auf GitHub gepflegt und mit Hugo in die Website umgewandelt. Änderungen lassen sich entweder direkt im Webbrowser oder mit dem normalen Git-Workflow einreichen.

Manueller Prozess über die Website

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.

Git-Workflow (empfohlen für grössere Änderungen)

Installieren Sie Git und klonen Sie das Repository: git clone https://github.com/I14Y-ch/handbook.git.
Erstellen Sie einen Branch für Ihre Änderung: git checkout -b mein-änderungsvorschlag.
Passen Sie die Dateien im Verzeichnis content an. Beachten Sie dabei die Markup-Syntax-Regeln.
Prüfen Sie Ihre Änderungen, speichern Sie sie und schicken Sie sie zu Github:
- git add <datei>
- git commit -m "Änderung: kurzer Titel"
- git push -u origin mein-änderungsvorschlag.
Erstellen Sie auf der GitHub-Website einen Pull Request. Beschreiben Sie kurz, was geändert wurde und warum. Ihr Vorschlag wird zeitnah vom I14Y-Team geprüft und allenfalls ins Handbuch integriert.