Schulung Software-Dokumentation mit Sphinx

Schulungsformen

Inhouse-/Firmenschulung

2 Tage - anpassbar
Termin nach Wunsch
Preis nach Angebot
In Ihrem Hause oder bei der GFU

Inhalte werden auf Wunsch an die Anforderungen Ihres Teams angepasst.

Unverbindlich anfragen

Individualschulung

2 Tage - anpassbar
Termin nach Wunsch
Preis nach Angebot
In Ihrem Hause oder bei der GFU

1 Teilnehmer = max. Fokus aufs Fachliche und max. Raum für individuelle Fragen.

Unverbindlich anfragen

Beschreibung

Die Dokumentation von Software muss heutzutage in verschiedenen Ausgabeformaten erstellt werden, um Anwendern sowohl ein gedrucktes Handbuch als auch eine Online-Hilfe zur Verfügung zu stellen. Eine gute Dokumentation gilt als Qualitätsmerkmal von Software und entscheidet nicht selten über den Erfolg eines Projekts. Ähnliche Anforderungen gelten für die Dokumentation zum Beispiel eines Qualitätsmanagementsystems nach ISO 9001 oder eines Information Security Management Systems ISMS nach ISO/IEC 27001:2013. Von Bedeutung ist hierbei auch die Revisionssicherheit, also zum Beispiel die Nachvollziehbarkeit von Änderungen.

Das Dokumentationssystem Sphinx gewährleistet im Zusammenspiel mit dem Versionskontrollsystem Git eine leichtgewichtige Lösung für diese Herausforderungen. Sphinx wurde ursprünglich zur Dokumentation von Python-Programmen entwickelt. Das Open-Source System kann aber auch Programme in anderen Programmiersprachen dokumentieren. Darüber hinaus ist es ganz allgemein als Single-Source Multi-Channel Publishing-Lösung
einsetzbar.

Schulungsziel

Sie sind nach dem Seminar in der Lage, Dokumentationen mit Sphinx zu erstellen und versionskontrolliert in mehreren Ausgabeformaten online und offline zu publizieren. Sie können die Dokumentation von Software ebenso wie die Software selbst in einem Versionskontrollsystem pflegen. Sie wissen, wie Sie Sphinx Ihren Bedürfnissen anpassen und wo Sie bei komplexen Fragestellungen und Problemen Hilfe finden können.

Details

Inhalt Wer teilnehmen sollte Ihre Schulung Organisation Buchen ohne Risko Kostenfreie Services

Wer teilnehmen sollte

Teilnehmen können Entwickler, die eine gute Dokumentation als Qualitätsmerkmal für Software begreifen und eine bequeme Möglichkeit suchen, eine hochwertige Dokumentation zu erstellen. Außerdem eignet sich die Schulung für Qualitätsmanager, IT-Verantwortliche,
Projektleiter und andere Autoren, die ein plattformübergreifendes System zur Erstellung von Dokumentationen suchen, das einfach zu bedienen ist und diverse, qualitativ hochwertige Ausgabeformate bereitstellt.

Ihre Schulung

Lernmethode:: Ausgewogene Mischung aus Theorie und Praxis
Unterlagen:: Seminarunterlagen oder Fachbuch zum Seminar inklusive, das man nach Rücksprache mit dem Trainer individuell auswählen kann
Arbeitsplatz:: PC/VMs für jeden Teilnehmer
Hochwertige und performante Hardware
Große, höhenverstellbare Bildschirme
Zugang zu Ihrem Firmennetz erlaubt
Lernumgebung:: Neu aufgesetzte Systeme für jeden Kurs in Abstimmung mit dem Seminarleiter.
Arbeitsmaterialien:: Din A4 Block, Notizblock, Kugelschreiber, USB-Stick, Textmarker, Post-its
Teilnahmebescheinigung:: Wird am Ende des Seminars ausgehändigt, inkl. Inhaltsverzeichnis

Organisation

Teilnehmerzahl:: min. 1, max. 8 Personen
Schulungszeiten:: 2 Tage - anpassbar, 09:00 - 16:00 Uhr
Ort der Schulung:: GFU Schulungszentrum
Am Grauen Stein 27
51105 Köln-Deutz
oder europaweit bei Ihnen als Inhouse-Schulung
Räumlichkeiten:: Helle und modern ausgestattete Räume mit perfekter Infrastruktur
Catering:: Frühstück, Snacks und Getränke ganztägig, Mittagessen im eigenen Restaurant, täglich 6 Menüs, auch vegetarisch
Barrierefreiheit:: Das GFU-Schulungszentrum(Am Grauen Stein 27) ist barrierefrei

Buchen ohne Risiko

Rechnungsstellung:: Erst nach dem erfolgreichen Seminar. Keine Vorkasse.
Stornierung:: Kostenfrei bis zu 3 Wochen vor dem Seminartermin

Kostenfreie Services

Eigener Shuttle Service Reservierte Parkplätze Hotelreservierung

Inhalt

Installation der Software (Sphinx und Git)
Einrichtung und Konfiguration eines Dokumentationsprojekts mit Hilfe von sphinx-quickstart
Gliederung und Organisation der Dokumentation
ReStructured-Text-Markup
Erzeugung verschiedener Ausgabeformate (HTML, PDF, HTML-Help, QTHelp, EPUB)
Konfigurationsmöglichkeiten für die HTML- und PDF-Ausgabe
Wichtige Sphinx-Befehle
HTML-Theming
Automatische API-Dokumentation
Testen von Codebeispielen mit Doctests
Versionierung mit Git
Informationsquellen im Internet