CMS oder Wiki für Softwaredokumentation und Benutzerhandbücher, Offline-Spiegelung möglich

Ich suche derzeit den Markt nach einer Software-Dokumentations- und Benutzerleitfadenlösung für unsere Organisation ab.

Wir sind ein mittelgroßer .Net-Softwareshop, der derzeit kompilierte .chm-Dateien mit unseren Releases versendet, ein Prozess, der unserer Meinung nach etwas antiquiert ist und uns nicht die Möglichkeit eines richtigen Layouts gibt. Da wir diese Dokumentation als Benutzerhandbuch nutzen wollen, benötigen wir moderne Vorlagenmöglichkeiten und mediale Unterstützung. Die Dokumentationserstellung soll vom Entwickler zum Produktmanager wechseln und muss daher auch für Nicht-Programmierer einfach bedienbar sein. Wir planen, eine funktionierende Offline-Spiegelung dieser Dokumentation mit Releases zu verteilen, daher ist die Option zur Offline-Verteilung von entscheidender Bedeutung. Die Option, diese Dokumentation auch online zu hosten und vollständig durchsuchbar zu machen, wäre ein großer Bonus. Wir haben etwas Angst vor Sicherheitslücken, daher sind uns Codequalität und Update-Richtlinien ein großes Anliegen. Lizenzkosten sind möglich, wenn die kostenpflichtige Lösung mehr Vorteile bietet. Kommerzielle Bereitstellungen (möglicherweise mit Modifikationen) sind ein Muss.

Ich habe mir bisher einige Wikis und CMS angeschaut, bin aber etwas ratlos, welche Software eine wartbare Lösung für unsere speziellen Anforderungen wäre. Ich bin auch der Meinung, dass unsere Anforderungen nicht so ausgefallen sein sollten, dass niemand spezialisierte Lösungen für dieses Thema anbietet.

Ich bin dankbar für jede Hilfe, die Sie mir geben können.

Antworten (1)

Ich würde vorschlagen, dass Sie eine Software verwenden, die speziell für die Dokumentation entwickelt wurde. Ich habe mehrere davon verwendet, die alle kostenlos und Open Source sind. Jeder ist etwas anders, aber sie sind alle ziemlich gut, also würde ich sie mir alle ansehen und dann den auswählen, der dir am besten gefällt.

Hier ist eine Liste derjenigen, die ich selbst verwendet habe (oder überlegt habe). Jeder hat seine Stärken und Schwächen, daher werde ich keine einzige Option empfehlen:

  • Sphinx ist ein Python-Programm, das Dokumentations-HTML-Sites (und PDF-Dateien) aus reStructuredText-Dokumenten erstellt.
  • ReadTheDocs ist eine auf Sphinx aufbauende Webanwendung mit einigen Projektmanagementfunktionen. Wenn Sie Sphinx nicht direkt verwenden möchten, können Sie die RTD-Website verwenden oder Ihre eigene Kopie auf Ihrem eigenen Server ausführen.
  • MkDocs ähnelt Sphinx und erstellt eine sehr gut aussehende Dokumentation. Das heißt, es ist viel neuer und es gibt noch einige Fehler, die ausgebügelt werden müssen.
  • Slate ist eines der neueren Programme und wurde mit Schwerpunkt auf technischer API-Dokumentation entwickelt. Allerdings gibt es Unternehmen, die es auch für ihre Benutzerhandbücher verwenden. Unten auf der Seite befindet sich eine Liste mit Beispielhandbüchern, die einige Beispiele enthält, die nicht von APIs stammen.

Es gibt noch einige mehr, die ich gesehen, aber nicht benutzt habe, also kann ich sie nicht kommentieren. Der Vollständigkeit halber füge ich sie jedoch hinzu. Möglicherweise finden Sie, dass einer von ihnen besser passt.

CMS oder Wiki für Softwaredokumentation und Benutzerhandbücher, Offline-Spiegelung möglich
AntwortenHierDatenschutz-Bestimmungen1y, 0v