Mein Unternehmen pflegt derzeit unsere technische Dokumentation (Benutzerhandbuch) in Google Docs. Mit jeder Veröffentlichung erstelle ich ein PDF, das wir auf unserer Website hosten.
Hier sind die Funktionen von Google Docs, die gut funktionieren:
Und das nicht so Schöne:
Ich habe die Aufgabe, ein neues "Tool" zu finden, das die folgenden Anforderungen unterstützt:
Ich bin offen für Ideen in Bezug auf die Plattform, obwohl ich etwas Cloud-basiertes lieben würde.
Hier ist, was wir dafür tun. Es ist nicht Cloud-basiert, aber es wird durch die Quellcodeverwaltung unterstützt, wie es (hoffentlich) Ihr Code bereits ist.
Beteiligte Tools und Technologien:
Quellcodeverwaltung
DocBook-DTD
Ihr Lieblingseditor für XML-Dateien (WYSIWYG möglich)
XSLTProc (mit ant, aber Sie könnten stattdessen make oder etwas anderes tun)
XEP (PDF-Generator)
(veraltet, aber ich erwähne es trotzdem): HTMLHelp Compiler
Wir schreiben unsere Dokumentationsquelle gegen die DocBook DTD. Dies ist ein etablierter Dokumentationsstandard, und obwohl die gesamte Spezifikation umfangreich ist, benötigen Sie wahrscheinlich nur etwa 20 XML-Elemente (Tags). Alles Übliche ist vorhanden – Unterteilungen (Buch, Kapitel, Abschnitt usw.), Formatierung (Hervorhebung, Code usw.), Semantik (Klassenname, Methodenname, Befehl, GUI-Element usw.), Indizierung, Inhaltsverzeichnis und so weiter.
Neben der DocBook-XML-Quelle gibt es Stylesheets, die Ihre XML-Eingabe in eine beliebige Ausgabe übersetzen. DocBook enthält einige davon. Wir füttern XSLTProc mit der XML-Quelle und den Stylesheets, um eine Zwischenausgabe zu erzeugen, die Objekte formatiert (FO). Wir haben dann einen Schritt, um das in PDF (mit XEP), HTML (mit XSLTProc) und (wir machen diesen Teil nicht mehr) eine CHM-Datei des HTML-Dokuments (mit HTMLHelp Compiler) umzuwandeln.
Wir packen all diese Generierungsschritte in eine Ant-Build-Datei (ant ist das, was wir bereits für unsere Software-Builds verwenden), aber es gibt keinen Grund, warum Sie dies nicht über make oder was auch immer Ihr bevorzugtes Build-Tool ist, tun könnten.
Die XML-Quelle wird in die Quellcodeverwaltung eingecheckt, und die Zusammenarbeit erfolgt auf die übliche Weise. XML unterstützt das Einbinden von Dateien, sodass Sie Ihre Bücher nach Belieben modularisieren können. Da sich die Dokumente in unserem Quellcodeverwaltungssystem befinden, ist es einfach, sie zu verzweigen und zu taggen, und die automatisierten nächtlichen Builds enthalten eine Dokumentation.
Da die Quelle XML und kein Binärformat ist, funktionieren Diff und Merge wie erwartet, und Sie können jeden beliebigen Editor verwenden. Einige unserer Leute verwenden Abortext Epic (ziemlich High-End), einige verwenden Oxygen, einige verwenden NotePad + XML, und mindestens eine altmodische Person (ähm) verwendet Emacs.
Vielleicht schließe ich aus deiner Frage zu viel, aber...
Es kann sich lohnen, sich eine Collaboration-Suite anzusehen ... mit einem so kleinen Shop kostet es nicht viel und die Tools bieten Cloud-Speicher und Versionierung, Web-Veröffentlichung, Sie können die Dokumente aus dem Tool heraus bearbeiten ... Genehmigungen, gemeinsame Nutzung , Diskussionen, alles Mögliche. Jetzt sind diese ... Peripheriegeräte für das Werkzeug, das das Dokument tatsächlich erstellt. Sie könnten also ein Word-Dokument oder ein PDF in der Cloud auf einem dieser Tools hosten (Word kann alle von Ihnen aufgelisteten Elemente verwalten). Ich habe kein Tool gesehen, das Dokumente sowohl erstellt als auch veröffentlicht (zumindest nicht effektiv ...). kann integriert sein und vom selben Anbieter stammen, aber es sind normalerweise zwei Tools.
Ich schätze, mein Vorschlag läuft darauf hinaus, das gewünschte Dokumenterstellungstool zu verwenden und dann ein Kollaborationstool zu verwenden, um Veröffentlichungen, Überprüfungen, gleichzeitige Arbeit usw. zu verwalten.
Werfen Sie einen Blick auf einige der folgenden.
Dieses Tool ist 10/Benutzer/Monat und bietet die gemeinsame Nutzung von Dokumenten und die Zusammenarbeit.
Huddle ist etwas teurer, 20/Benutzer/Monat, aber sehr funktionsreich ... es kann alle möglichen coolen Sachen machen, einschließlich vorgefertigter Apps für den mobilen Zugriff.
Dieser ist etwas weniger robust, aber für bis zu 20 Benutzer kostenlos.
Hoffentlich hilft das, wenn ich weit vom Ziel entfernt bin, lassen Sie es mich wissen, ich kann diese Antwort jederzeit entfernen.
Ich würde sagen, Sie suchen nach einem Cloud-basierten Help-Authoring-Tool (HAT), sei es als SaaS oder gehostet auf Servern auf Ihrem Firmengelände.
Wir haben WebWorks ePublisher verwendet , der in verschiedene Arten von HTML-Formaten ausgibt (z. B. die eigene HTML-Ausgabe von WebWorks, HTML-Hilfe usw.). Es bietet auch Cloud-Hosting vor Ort (CloudDrafts). Seine Hauptstärke ist die schiere Anzahl der angebotenen Ausgänge, die in Ihrem Fall vielleicht übertrieben sind, aber dennoch einen Blick wert sind.
Sie könnten auch einige SaaS-Lösungen wie ClickHelp in Betracht ziehen . Einige Anbieter wie MadCap Software bieten ihre HATs in Kombination mit einer zusätzlichen Lösung an, die Sie erwerben müssen, um sie cloudbasiert zu machen.
Ich habe eine weitere Liste von SaaS-HATs auf DocToolHub , wenn Sie interessiert sind ... wählen Sie einfach die Filter für "Hilfe-Autorentools", "SaaS" und "PDF" aus.
Wenn Sie die Dokumentation für mehrere Produkte unterstützen möchten, ist die Wiederverwendung von Inhalten (effizienter als Kopieren und Einfügen) wünschenswert. Wenn dies der Fall ist, erfüllt ein Tool wie Author-it Ihre Anforderungen: mehrere Ausgabeformate, einschließlich PDF und HTML, korrekte Buchformatierung (Inhaltsverzeichnis, Index usw.), hochgradig anpassbare Stile.
Die Funktionen für die Zusammenarbeit sind etwas anders strukturiert als beim Google Docs-Modell: Ein Autor kann jeweils an einem Textstück arbeiten, aber dieses Textstück kann klein sein (ein Abschnitt). Der Autor richtet einen Review-Workflow ein, in dem andere Kommentare abgeben, aber die Quelle nicht direkt ändern können. Dies verhindert Bearbeitungskriege und das Vermasseln mühsam geschriebener Inhalte durch Amateure.
Was es von den üblichen Tools für die Zusammenarbeit im Büro unterscheidet, ist die Möglichkeit, Inhalte von einzelnen Sätzen bis hin zu ganzen Kapiteln wiederzuverwenden. Das spart viel Zeit, wenn Sie Dokumentationen für mehrere Produkte erstellen.
Wir verwenden Help & Manual seit sieben Jahren. Hat ungefähr 8 Ausgabeformate, verwendet XML als Backend, integriert sich gut in svn und lässt sich leicht mit OmegaT übersetzen. Ermöglicht gleichzeitige Benutzerlizenzen (wir haben zwei).
James
tmcallaghan