Dokumentation

Sphinx - unser Lieblingstool

Sphinx stellt sich selbst vor mit den Worten: "Sphinx is a tool that makes it easy to create intelligent and beautiful documentation[...]". Das sehen wir genauso. Mit Sphinx lassen sich Textdateien in diverse Zielformate wie HTML und PDF übersetzen. Für die Formatsteuerung sorgt die bewährte Markup-Sprache reStructuredText.

Was zunächst kompliziert erscheinen mag, erweist sich bei genauerer Betrachtung in vielerlei Hinsicht als äußerst vorteilhaft. So lassen sich aus Textdateien Inhalte vergleichsweise leicht automatisch extrahieren und weiterverarbeiten. Vollständigkeits- und Konsistenzprüfungen sind so effizient umsetzbar.

Wenn Sie HTML als Ausgabeformat wählen, können Sie das Ergebnis direkt in Ihrem Intranet veröffentlichen. So sind Ihre Mitarbeiterinnen und Mitarbeitern von wichtigen Informationen immer nur wenige Klicks entfernt.

Projektdokumentation

Projekte sind Organisationen auf Zeit mit eigenen Regeln und Vorgehensweisen. Daher ist es besonders wichtig, Informationen allen Team-Mitglieder schnell und einfach zur Verfügung zu stellen. Kommunikation ist zweifellos ein kritischer Erfolgsfaktor.

Was macht Sphinx für das Projekte so attraktiv?

Teamwork

Modularität für paralleles Arbeiten

Ausgabeformate

wahlweise HTML oder PDF

Analysierbarkeit

mehr Qualität durch automatisierte Prüfungen

Querverweise

intelligentes Referenzieren interner und externer Quellen

Ein klassischer Anwendungsfall sind Plandokumente aller Art wie zum Beispiel das Projekthandbuch. Machen Sie das geplante Vorgehen im Projekt für alle Teammitglieder transparent! Wir beraten Sie gerne!

Qualitätsmanagement

Auch im Qualitätsmanagement kann Sphinx mit dem richtigen Know-How punkten. Denken Sie nur an die Dokumentation von Prozessen, ohne die kaum ein Unternehmen auskommt. Nur wenn Prozesse bekannt sind, können Sie auch gelebt werden! Daher kommt einem barrierefreien Zugang zentrale Bedeutung zu.

Mit der von uns entwickelten Dokumentationsstrategie für Prozesse ist es darüber hinaus möglich, Prozesslandkarten aus Prozessdokumenten zu erstellen. Zudem können Unstimmigkeiten an den Prozessschnittstellen - eine oft beobachtete Problemursache - sicher identifiziert werden.

Wir sorgen dafür, dass bei Ihnen ein Rad ins andere greift!