Redaktions-Handbuch

Überblick

Zusammenfassung

Willkommen im Redaktions-Handbuch!

Erfahren Sie in diesem Bereich der Online-Dokumentation, wie Sie mit Hilfe von GitLab und Docusaurus Dokumentationswebsites erstellen.

Im Redaktions-Handbuch finden Sie

• Hilfestellungen rund um den Umgang mit GitLab und Markdown
• Hinweise zur Barrierefreiheit
• dem Betrieb einer Site u. A. im Föderalen Entwicklungsportal.

Es ist für Einsteigende wie Fortgeschrittene gleichermaßen geeignet.

Dieser Bereich der Online-Dokumentation ist folgendermaßen gegliedert:

• Auf dieser Seite geben wir Ihnen einen Überblick über die Inhalte des Redaktions-Handbuchs und zeigen Ihnen, wo Sie Unterstützung in einer gleichgesinnten Community finden.
• Auf der Seite Vorüberlegungen geben wir Hinweise, welche organisatorischen Punkte rund um die Erstellung einer Dokumentationswebsite geklärt werden sollten, um eine qualitativ hochwertige Dokumentation zu erzeugen und eine reibungslose Implementierung sicherzustellen.
• Die Seite Entscheidungshilfe unterstützt Sie dabei, einzuordnen, ob eine Dokumentationswebsite im Föderalen Entwicklungsportal für Ihre Organisation zielführend ist.
• Auf der Seite Barrierefreiheit finden Sie eine kurze Checkliste für Autor:innen, insbesondere zur Gestaltung von Grafiken, sowie weiterführende Links.
• Verschaffen Sie sich anschließend einen Überblick über die Topologie und die beteiligten Komponenten und lernen Sie die zentralen Begriffe und Bestandteile kennen.
• Die Arbeit mit Gitlab vermittelt alle notwendigen Informationen für den sicheren Umgang mit den Inhalten eines Repositories.
• In der Anleitung zur Inhaltsbearbeitung erfahren Sie alles, was für das Arbeiten mit Markdown in Verbindung mit Docusaurus wichtig ist.
• Im Bereich Design finden Sie Hinweise zur Gestaltung von Seiten, darunter Design-Tipps, Admonitions, aufklappbare Bereiche (Details) und Hinweise zum Erstellen von FAQ-Seiten.
• Die Seite Zusatzfunktionen enthält Beschreibungen zusätzlicher Funktionen in Form von Plugins oder React-Komponenten, die für die Erstellung von Dokumentationswebsites einen Zusatznutzen haben können.
• Abschließend wendet sich Inbetriebnahme speziell an technisch Verantwortliche. Dort wird erläutert, wie ein neues Repository erstellt wird und welche Konfigurationseinstellungen anschließend im Repository vorgenommen werden müssen, um eine automatisierte Bereitstellung von Previews und der resultierenden Dokumentationswebsite sicherzustellen.

Dokumentation gemeinsam verbessern – machen Sie mit!

Sie arbeiten mit Docusaurus und haben eine Frage, suchen praktische Tipps, Austausch oder Unterstützung bei der Erstellung von Dokumentationen?
Profitieren Sie vom Schwarmwissen! In unserem Matrix-Channel helfen wir uns gegenseitig – schnell und unkompliziert:

#docs‑community:matrix.org

• Aktuell etwa 30 Kolleg:innen aus der öffentlichen Verwaltung – alle mit ähnlichen Herausforderungen.
• Stellen Sie Ihre Fragen und erhalten Sie praktische Tipps aus dem Arbeitsalltag.
• Jetzt vorbeischauen und mitmachen!