PDF-Download

Schulung Software-Dokumentation mit Sphinx (S1292)

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.

Buchungsmöglichkeiten

Firmenschulung Anfragen
Inhouse-Schulung Anfragen
Individualschulung Anfragen

Preis

Auf Anfrage

Dauer

2 Tage. Die vorgeschlagene Dauer kann Ihren Bedürfnissen angepasst werden.

Schulungs-Ziel

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. 

Wer sollte teilnehmen

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.

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

Schulungszeiten und Teilnehmerzahl

Teilnehmerzahl:min. 1, max. 8 Personen

Schulungszeiten: 2 Tage, 09:00-16:00

Ort der Schulung: GFU-Schulungszentrum Köln oder bei Ihnen als Inhouse-Schulung

Haben Sie Fragen?

Gerne beraten wir Sie persönlich per E-Mail oder Telefon.

Nicole Döhring

Kathrin
Gerstmann

Petra
Humartus

Ilona
Dick