Wiki-ähnliches Tool zum Schreiben von Spezifikationen und Dokumentation [geschlossen]


9

Ich suche ein Wiki oder ein Wiki-ähnliches System zum Schreiben und Verwalten von Spezifikationen und Dokumentationen für ein Softwareprojekt.

Ich weiß, dass es viele Wiki-Implementierungen gibt, aber gibt es einige, die für diese Art von Aufgabe besonders gut geeignet sind?

Eigentlich muss es kein Wiki sein, sondern nur ein System, das das Schreiben und Navigieren von Spezifikationen und Dokumentationen vereinfacht und das die Ablaufverfolgung von Änderungen unterstützt.


1
Verwenden Sie eine spezielle Plattform? Wie zum Beispiel das TFS von Microsoft?
Saeed Neamati

In Anlehnung an die Frage von @Saeed, welche Art von Infrastruktur verfügt Ihr Team / Ihre Organisation bereits für das Wissensmanagement und den Wissensaustausch? Was sind Ihre aktuellen Prozesse zum Schreiben von Spezifikationen und Dokumenten?
Thomas Owens

Antworten:


6

Wir verwenden LaTeX und SVN. Da LaTeX-Dokumente nur Textdateien sind, funktioniert es im Gegensatz zu einigen binären oder teilweise binären Formaten gut mit der Versionskontrolle.

Sie erhalten alle Vor- und Nachteile der Versionskontrolle, die Sie gewohnt sind, wenn Sie sie mit Ihrem Code verwenden.

LaTeX muss ein wenig eingerichtet werden (um Ihre eigenen Stile / Klassen zu definieren), aber wenn Sie dies getan haben, ist es sehr gut - Sie können sich nur auf den Inhalt und nicht auf dessen Präsentation konzentrieren (anstatt versucht zu sein, ständig Änderungen vorzunehmen, während Sie gerade dabei sind WYSIWYG), erhalten aber am Ende immer noch ein schickes, professionell aussehendes PDF-Dokument.


4

Ich persönlich mag Tiddly Wiki sehr .

Es hat eine ziemlich vollständige Wiki-Syntax, ist eine eigenständige einzelne HTML-Datei und funktioniert gut mit einer Vielzahl von Webbrowsern, ohne dass ein Server erforderlich ist.

Es hat sogar eine erweiterbare Plugin-Architektur, mit der Sie Plugins hinzufügen können, um alle möglichen interessanten Dinge wie das Verschlüsseln von Tiddlern oder das Hinzufügen von Fußnoten zu erledigen.


3

Für die Microsoft-Plattform ist die Integration von TFS (Team Foundation Server) in SharePoint genau das, wonach Sie suchen. Durch das Erstellen eines neuen Teamprojekts können Sie eine Vorlage auswählen, die nahezu alle Aspekte des Softwareentwicklungsprozesses umfasst. Es bietet Ihnen ein Portal, in dem Sie Teammitglieder definieren, ihre Rollen und Sicherheitsberechtigungen zuweisen, Dokumente und Spezifikationen für Ihr Projekt hochladen, freigeben und bearbeiten sowie viele andere coole Dinge damit tun können.

Für andere Plattformen können Sie so etwas wie GitHub verwenden (ich bin mir jedoch nicht sicher).



0

Sie können Sphinx ausprobieren , wobei die Dokumente in die Infrastruktur Ihrer Wahl zur Quellcodeverwaltung eingecheckt werden. Dies hat die Vorteile der Quellcodeverwaltung und der relativ einfachen Markup-Sprache reStructuredText , die leicht zu erlernen und für Konvertierungen (in HTML, PDF usw.) recht gut instrumentiert ist.

Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.