Sphinx – Technische Dokumentation

Unsere Schulung "Sphinx - Technische Dokumentation" bereitet Sie umfassend darauf vor, Sphinx für Ihre technische Dokumentation zu verwenden, Ihren Ansprüchen entsprechend zu konfigurieren und Ihre Dokumente exakt in den geforderten Ausgabeformaten bereitzustellen. Die Schulung richtet sich einerseits an Entwickler, die in Sphinx eine praktische Methode für ihre professionellen Dokumentation finden möchten, und andererseits an technische Redakteure, die die diversen Vorzüge der praktischen Arbeit mit Sphinx für sich nutzen möchten. Es bestehen für die Teilnahme keine besonderen Voraussetzungen.

Die Schulung beginnt - wie auch Ihre spätere Arbeit mit Sphinx - mit der grundlegenden Installation und Bereitstellung des Systems. Der gesamte Prozess wird Ihnen von unserem Sphinx-Profi im Detail erklärt und anhand diverser Praxisbeispiele Schritt für Schritt verdeutlicht. Sie erlernen im darauf folgenden Schulungsabschnitt, wie Sie mittels sphinx-quickstart ein erstes eigenes Dokumentationsprojekt einrichten und konfigurieren. Weitere Möglichkeiten der Konfiguration (besonders für die Ausgabe im PDF- oder HTML-Format) werden Ihnen in diesem Zusammenhang ebenfalls erläutert.

Weiter geht es daraufhin mit der grundlegenden Gliederung bzw. Organisation Ihrer Dokumentation sowie mit der Generierung unterschiedlicher Formate für die Ausgabe, darunter beispielsweise QTHelp, EPUB und HTML. Unser professioneller Schulungsleiter macht Sie außerdem mit dem Sphinx- sowie mit dem ReStructured-Text-Markup und dem praktischen Umgang damit vertraut. Sie lernen das HTML-Theming in Ihrer technischen Dokumentation und erfahren, wie Sie sicher und kompetent mit Vorlagen (Templates) umgehen, um sich Ihre Arbeit effizient und dauerhaft einfacher zu gestalten.

Des Weiteren lernen Sie in diesem Sphinx Seminar, Docstrings innerhalb Ihrer Dokumentation automatisch zu integrieren. Mittels Doctests können Sie Ihre Dokumentation zuverlässig testen - wir zeigen Ihnen im Schulungsverlauf, wie genau das funktioniert und welche Vorteile Sie daraus für sich und Ihre tägliche Arbeit mit Sphinx ziehen können. Die Schulung endet mit einem abschließenden Modul, in dem das Gelernte noch einmal Revue passiert und diskutiert wird und in dem Ihnen einige hilfreiche Informationsquellen in Netz genannt werden, die Ihnen bei Ihrer Arbeit nach Abschluss der Schulung noch zahlreiche wertvolle Infos zum Nachschlagen bieten. Dieses Abschlussmodul bietet außerdem auch die Möglichkeit, eventuelle offene Fragen zu klären, damit Sie optimal von Ihrer Schulungsteilnahme profitieren können.