Du hast eine Frage? Stell sie der t3n-Community!

? Beispielfragen

Um selbst eine Frage online zu stellen, melde dich bitte an.

Zur Anmeldung

« zurück zur Übersicht

Welche Software eignet sich für die Erstellung von Dokumentation?

13 Punkte

4 Antworten

von rado.intersales.de  Newbie  vor über 2 Jahren

Als Software-Hersteller müssen wir sowohl für Anwender wie auch intern für die Entwickler Dokumentation erstellen und pflegen. In der Vergangenheit haben wir das mit normalen Textverarbeitungswerkzeugen wie Word und Openoffice gemacht, jedoch stößt man hierbei schnell an Grenzen.

Denn die Anforderungen lauten: flexibles Publizieren in verschiedene Formate und Medien (HTML, PDF, Datenbank, Papier…), gemeinsames Bearbeiten im Team, ggf. auch mit Versionierung, unterschiedliche Views (Anwender sehen online beispielsweise nur den Anwender-Anteil, Entwickler sehen alles; Kommentierung.

Weder Wikis sind wirklich geeignet, noch konventionelle CMS wie z.B. TYPO3.

Bin bei meinen ersten Recherchen auf DocBook als verbreitetes Standard-Format gestoßen, würde mich aber sehr dafür interessieren, wie Kolleg/innen an dieses Thema rangehen.

Nachträglich bearbeitet am 06.02.10 14:44

Links

Kommentare

Melde dich an, um einen Kommentar zu schreiben.

4 Antworten

6 Punkte

von vmoench  Geek  vor über 2 Jahren

Wir verwenden Help&Manual und sind sehr zufrieden. Genannte Feature wie “unterschiedliche Views” = Conditional Tags sind enthalten. Format ist XML, dadurch ist man sehr flexibel. Ist schnell, stabil und lernen braucht man es nicht, versteht sich alles von selbst. Gleichzeitig im Team arbeiten geht ebenfalls.

Da wir aber auch eine Typo3-Site haben und wir dadurch immer alles doppelt und dreifach machen, überlege ich dennoch, unsere Doku in Zukunft in Typo3 zu schreiben.

Nachträglich bearbeitet am 02.02.10 09:33

Links

Kommentare

  • der_hauke: Das Programm sieht ja sehr gut aus, gibt es etwas vergleichbaren auch als opensource oder als freeware?

    vor über 2 Jahren

  • vmoench: Warum muss es denn auch für einen Software-Hersteller Freeware sein? Gerade ihr solltet doch gute Arbeit bewerten und honorieren können. Und H&M kostet nun nicht die Welt. OpenSource heißt eigentlich nicht, ich will alles umsonst, sondern ich bekomme es umsonst und beteilige mich an dem Projekt. Vor diesem Huntergrund kann dann ClosedSource für einen angemessenen Preis sich mehr rechnen.

    vor über 2 Jahren

  • der_hauke: Das sehe ich auch so, wer gute Arbeit macht soll auch entsprechend honoriert werden. Aber angenommen ich entwickle ein open source oder ein non-profit Projekt, dann möchte ich nicht unbedingt so viel Geld für eine Dokumentationssoftware ausgeben.

    vor über 2 Jahren

  • vmoench: Da bin ich absolut mit dir einig. Ich habe auch schon Lizenzen erlebt, die kostenlos waren, wenn die Software für OS-Projekte eingesetzt wurde. Wenn ihr OpenSource entwickelt, würde ich an deiner Stelle auch OpenSource suchen. Ihr bringt ja demnach auch was in die Community ein. Aber ich befürchte, da gibt es nichts in der Liga Help&Manual.

    vor über 2 Jahren

Melde dich an, um einen Kommentar zu schreiben.

2 Punkte

von leolezner  Heavy User  vor über 2 Jahren

Ich könnte Latex empfehlen. Es ist perfekt für lange Dokumentationen, hat viele Pakte/Plugins. Nach einer Zeit liebt man es, aber am Anfang hasst man Latex, weil es wie eine Programmiersprache aussieht und meist nicht das tut, was man will. Ich habe mein ganzes Studium Word benutzt und über Leute gelacht, die Latex benutzten (“Ach, die kompilieren ihre PDF”). Während der Bachelorarbeit habe ich gemerk, dass es für Dokus einfach perfekt ist.

Da man reinen Text schreibt, kann Versionierung mit SVN oder Git erledigt werden. Die Doku lässt sich modular Aufbauen, ein Entwickler kann an einem Kapitel arbeiten, später in einer Sekunde alles zusammenfügen.

PDF lässt sich erstellen, aber ich vermute, dass auch HTML und weitere Formate möglich sind.

Nachträglich bearbeitet am 03.02.10 09:15

Kommentare

Melde dich an, um einen Kommentar zu schreiben.

0 Punkte

von nicolette  Heavy User  vor über 2 Jahren

http://www.naw.info/de/leistungen/technische-redaktion-dita.html

Kommentare

  • rado.intersales.de: DITA klingt interessant. Ich war im weiteren Verlauf meiner Recherchen (im Anschluß an meine Frage hier) auf DocBook gestoßen. Ist z.B. im Zusammenspiel mit Dobudish als fertiges Toolset sofort einsetzbar. DITA scheint dabei konkret diverse Nachteile von DocBook zu adressieren.

    Ausgehend von XML als Basis für Dokumentation habe ich in Apache Forrest eine nicht so stark typisierte und standardisierte Variante gefunden ,die eher technikgetrieben ist: dynamische Publikation in diverse Zielformate, wobei unterschiedlichste Quellen und Eingangsformate verarbeitet werden können. Hat damit schon mal jemand Erfahrungen gemacht?

    Dobudish: http://www.agynamix.de/products/dobudish/
    Apache Forrest: http://forrest.apache.org/

    vor über 2 Jahren

Melde dich an, um einen Kommentar zu schreiben.

0 Punkte

von derredakteur  Newbie  vor über 2 Jahren

Um kostenlos technische Dokumentation zu erstellen, kenne ich zur Zeit drei Anwendungen:

Mehr Informationen zu diesen Anwendungen und um das Thema technische Dokumentation gibt es unter http://doc-x.org

Nachträglich bearbeitet am 07.02.10 19:39

Links

Kommentare

  • rado.intersales.de: Interessant. Kann bei Lenya allerdings nicht erkennen, wie / wodurch es gerade für das Erstellen von technischer Dokumentation geeignet sein soll. Da scheinen keine festen Strukturen vorgebbar zu sein und wie generiert man z.B. so etwas Triviales wie ein Inhaltsverzeichnis? Aber ich werde Deinen Blog-Bericht dazu abwarten! :)

    Daisy sieht interessant aus, mal sehen ob das Handbuch dazu interessante Details hergibt.

    vor über 2 Jahren

Melde dich an, um einen Kommentar zu schreiben.

Antwort schreiben

Um eine Antwort schreiben zu können, sollest du dich zuvor anmelden.

Zur Anmeldung

« zurück zur Übersicht