Tool für Software-Dokumentationszwecke

Ich bin Softwareentwickler und suche ein Tool, um in Zusammenarbeit mit meinem Team Softwaredokumentationen zu schreiben.
Das bedeutet, dass dieses Tool über einen Versionierungsmechanismus verfügen sollte, um die Möglichkeit zu erreichen, verschiedene Kapitel von verschiedenen Teammitgliedern zu schreiben.
Mit "Softwaredokumentation" meine ich so etwas wie ein Handbuch, keine technische Dokumentation.

Letzte Voraussetzung ist, dass dieses Tool Open Source sein sollte.

Kann mir jemand ein nützliches Tool für diesen Zweck empfehlen?

Danke im Voraus.

Nur Text mit vielleicht ein paar Grafiken – oder etwas Ausgefeilteres? ownCloud/Nextcloud wird mit einem LibreOffice-kompatiblen Editor ausgeliefert, der eine gemeinsame Bearbeitung ermöglicht, würde das ausreichen (es gibt einige Demos, die Sie ausprobieren könnten)? Wenn nicht, gibt es eine erweiterte Variante von LibreOffice, die separat verwendet oder auch in ownCloud/Nextcloud integriert werden kann. Die beiden *Clouds hatten den Vorteil, dass sie Ihnen sowohl Kalender/Kontakte als auch "Dateiablage" boten, die Sie mit dem Team nutzen konnten.
Bist du sicher, dass du wirklich Open Source meinst ? Planen Sie, den Code zu ändern und neue Funktionen hinzuzufügen? Wenn Sie einfach nicht bezahlen möchten, fügen Sie das Gratis -Tag hinzu. Und fügen Sie ein Tag für das Betriebssystem hinzu.
Gibt es einen Grund, warum der Texteditor zum Bearbeiten von Text + Git zum Versionieren nicht ausreicht?
Obwohl doxygen hauptsächlich für die technische Dokumentation gedacht ist, kann es auch für andere Dokumentationen verwendet werden (z. B. das doxygen-Handbuch wird mit doxygen erstellt). Anschauen lohnt sich also auf jeden Fall.

Antworten (1)

Ich würde dringend empfehlen, einen Blick auf die Werkzeugkette des Sphinx -Dokumentengenerators zu werfen.

Die Dokumenterstellung erfolgt als Satz von ReStructuredText- Dateien (mit der möglichen Einbeziehung einiger anderer Formate wie Markdown), die vollständig mit Versionskontrollsystemen wie Git, Svn, Mercurial usw. kompatibel sind. Vorlagen können verwendet werden, um zu geben einen konsistenten Stil für das endgültige, veröffentlichte Dokument.

Das endgültige Dokument kann in mehreren Formaten generiert werden, und einige Websites wie ReadTheDocs generieren Ihre Dokumente automatisch als Reaktion auf neue Commits und Veröffentlichungen (siehe hier ) für Ihr Repository oder das Ihres Teams auf Websites wie GitHub, Bitbucket oder GitLab.

  • Kostenlos, Gratis & Open Source
  • Plattformübergreifend (in Python geschrieben)
  • Eingabedateien sind vollständig mit der Versionskontrolle kompatibel
  • Ausgabeformate: HTML (einschließlich Windows-HTML-Hilfe), LaTeX (für druckbare PDF-Versionen), ePub, Texinfo, Handbuchseiten, einfacher Text
  • Umfangreiche Querverweise: semantische Auszeichnungen und automatische Links für Funktionen, Klassen, Zitate, Glossarbegriffe und ähnliche Informationen
  • Hierarchische Struktur: Einfache Definition eines Dokumentenbaums mit automatischen Verknüpfungen zu Geschwistern, Eltern und Kindern
  • Automatische Verzeichnisse: Allgemeines Verzeichnis sowie ein sprachspezifisches Modulverzeichnis
  • Code-Handhabung: automatische Hervorhebung mit dem Pygments- Highlighter, der die meisten (>300) Programmiersprachen verarbeitet.
  • Mehrere, gut aussehende Themen , die entweder als eingebaute Themen (etwa 8), Downloads von Orten wie PyPi , GitHub & sphinx-themes.org oder durch Schreiben Ihrer eigenen .
Tool für Software-Dokumentationszwecke
AntwortenHierDatenschutz-Bestimmungen1y, 0v