Software zum Erstellen und Pflegen von Benutzer-/Servicehandbüchern

Wir suchen nach einer Software, mit der wir Servicehandbücher für die von uns hergestellten Maschinen einfach erstellen und pflegen können. Wir haben etwa 25 Maschinen und haben bisher Microsoft Word verwendet, aber es ist extrem schwierig und zeitaufwändig, 25 Servicehandbücher zu pflegen, die mindestens 75 % der Texte und Bilder gemeinsam haben. Wenn wir eine Änderung vornehmen, müssen wir die anderen 24 öffnen und die gleiche Änderung vornehmen.

Wir brauchen etwas, das es uns erlaubt, eine Art "gemeinsamen" Text und Bilder zu verwenden, die in Platzhalter in den Handbüchern eingefügt werden, damit wir diese gemeinsame Quelle ändern können und sie auf alle Handbücher aktualisiert wird, ohne das Format zu verfälschen. Seitenzahlen und Index sollten ebenfalls automatisch aktualisiert werden.

Es sollte auch einen Bereich geben, in dem alle Handbücher für einen einfachen Zugriff organisiert sind, möglicherweise mit Revisionsspeicherung und Datumsangaben.

Windows ist die bevorzugte Plattform, aber ich bin auch offen für andere.

Muss das Ergebnisdokument im Word-Format vorliegen – oder gehen auch andere, zB PDF? Werden die "gemeinsamen Teile" ohne Anpassungen kopiert (abgesehen von vielleicht automatisch generierten Kapitelnummern und Fußnoten)? Wäre ein anderes Eingabeformat wie Markdown oder HTML für Sie in Ordnung (zumindest solange es GUI-Editoren dafür gibt)? Ich hätte einen Ansatz im Sinn, den ich leicht für Markdown -> PDF unter Linux skizzieren könnte (was wahrscheinlich auch unter Windows funktionieren wird, was ich nicht testen kann).
PDF ist auch gut, aber der Editor muss ein normaler Texteditor sein - die Benutzer sind nicht technisch genug für etwas anderes.
OK, dann könnte vielleicht so etwas wie Master Document passen: Ein "Master Document" ist im Grunde ein "Wrapper" um mehrere separate Dokumente. Sie lassen also Ihre Benutzer die "Abschnitte" in separaten Dokumenten bearbeiten und Masterdokumente verwenden, um sie zusammenzufügen. Von dort aus können Sie dann zB in PDF, HTML oder was auch immer Sie benötigen und unterstützt werden exportieren (AFAIR könnten Sie auf diese Weise sogar EPUB-eBooks erstellen).

Antworten (3)

Eine Option, die Sie sich ansehen sollten, ist Sphinx , die mehrere Dokumentationsformate ausgeben kann.

Merkmale:

  • Text wird als restrukturierter Text gespeichert , der reiner Text ist und somit leicht versioniert werden kann.
  • Kostenlos, Gratis & Open Source
  • Plattformübergreifend (in Python geschrieben)
  • Ausgabeformate: HTML (einschließlich Windows HTML Help), LaTeX (für druckbare PDF-Versionen), ePub, Texinfo, Manpages, einfacher Text.
  • Umfangreiche Indizierung, Querverweise etc.
  • Hierarchische Struktur: Einfache Definition eines Dokumentenbaums mit automatischen Verknüpfungen zu Geschwistern, Eltern und Kindern
  • Betten Sie Bilder und Diagramme in einer Reihe von Formaten (SVG ist das beste für diese Art von Dingen) aus externen Dateien ein.
  • Mehrere gut aussehende Themen oder definieren Sie Ihre eigenen.
  • Änderungen im gewünschten Aussehen können durch eine Themenänderung und anschließendes Neugenerieren des/der gewünschten Dokuments/Dokumente implementiert werden.
  • Einige Beispielseiten:
Außerdem können viele Dinge allein mit reStructuredText ohne Sphinx erreicht werden.

MS Word erledigt dies bereits für Sie. Ich kann bestätigen, dass ich gerade die Antwort auf diese Frage getestet habe und es funktioniert.

Gehen Sie zur Registerkarte Einfügen und klicken Sie dann auf Objekt (es befindet sich in der Unterkategorie Text ganz rechts). Anschließend sehen Sie folgenden Screenshot:

Geben Sie hier die Bildbeschreibung ein

Navigieren Sie zu der Datei und aktivieren Sie das Kontrollkästchen "Mit Datei verknüpfen". Sie können entweder die Quelldatei aktualisieren (ich würde dies tun, um Verwirrung zu vermeiden), oder wenn Sie sich in der Zieldatei befinden und versuchen, sie zu bearbeiten, wird die Datei tatsächlich in der Datei geöffnet. Schwer zu erklären, aber Sie werden es verstehen, wenn Sie es sehen.

Ich habe eine docuemtnA.docx erstellt, Text eingefügt. Dann erstellte ich B.docx, gab ihm etwas Text und in der Mitte folgte ich den oben gegebenen Anweisungen, um einen Link zu A.docx einzufügen. Ich habe dann A.docx aktualisiert und der Inhalt von B.doxc spiegelt die Änderung wider, ohne dass ich etwas unternommen habe.

Dies funktioniert für MS Word 2010. Die gleiche Funktionalität wird für andere Versionen vorhanden sein, aber möglicherweise sind andere Menüs erforderlich, um sie zu erreichen.

Glückwunsch! Sie sind jetzt der Held Ihrer Abteilung :-)

Ich schaue mir das an, werde zurückkommen und die Ergebnisse aktualisieren.
Bitte tun (+1), denn Ihre Konformation könnte in Zukunft anderen helfen, so wie ich Ihnen geholfen habe - und darum geht es beim Stack-Tausch :-)
Dies hat wie gesagt funktioniert, aber der Index (auch bekannt als Inhaltsverzeichnis) enthält nichts aus den externen Word-Dokumenten.
Das ist sowohl überraschend als auch enttäuschend; Ich kann sicherlich sehen, wie es ein Problem sein würde. Leider kann ich nicht helfen. Sie könnten versuchen, auf superuser.com oder in einem MS Office-Forum nachzufragen. Wenn Sie es zum Laufen bekommen, könnten Sie bitte hier posten, um anderen in Zukunft zu helfen.

LaTeX ist dafür gut geeignet. Es ermöglicht Dokumenten, andere Dokumente einzuschließen, und es ermöglicht Ihnen, Makros zu schreiben, um andere Arten von sich wiederholenden Elementen auszuklammern. Es ist im Allgemeinen viel weniger angenehm damit zu arbeiten als mit Sphinx (TeX zeigte bereits vor 10 Jahren sein Alter), aber es erlaubt Ihnen, alle möglichen ausgefallenen Dinge für den Drucksatz zu tun, wenn Sie die Geduld dafür haben, was nützlich sein wird wenn die Handbücher gedruckt werden sollen und im Druck hübsch aussehen sollen.

Software zum Erstellen und Pflegen von Benutzer-/Servicehandbüchern
AntwortenHierDatenschutz-Bestimmungen1y, 0v