Bestes Tool zum Erstellen von Benutzerhandbüchern

Wir planen, ein Benutzerhandbuch nur für den internen Gebrauch zu erstellen. Es handelt sich um ein 150-seitiges Dokument in Word für ein selbst entwickeltes SW-Tool. Das Benutzerhandbuch muss ständig aktualisiert werden. Es ist keine Übersetzung erforderlich. Wir hätten gerne - eine einfach zu bedienende Schnittstelle für das Tool - einfach zu aktualisieren - gute Funktionalität zur Kontrolle des Änderungsverlaufs, besser einen detaillierten Änderungsverlauf für jede Funktionalität der Software.

Hast du eine Empfehlung für das Tool?

Mir ist etwas unklar, was du hier suchst. Benötigen Sie Empfehlungen für die Benutzeroberfläche des Softwaretools oder Empfehlungen für Software, um das Benutzerhandbuch des Softwaretools zu aktualisieren? Wenn letzteres der Fall ist, was ist falsch daran, nur Word zum Erstellen von PDFs zu verwenden? Oder möchten Sie eine Bedienungsanleitung in der Software? (Im ersten Fall sind Sie leider auf der falschen Seite.)
Hallo Neil, ich suche nach einem Tool, um eine Bedienungsanleitung für das Tool zu erstellen. Da es sich um ein selbst entwickeltes Tool handelt, wird es ständig aktualisiert. Wir müssen diese Änderungen im Benutzerhandbuch widerspiegeln. Word wird schwierig sein, alle Änderungen aufzuzeichnen. ZB stellt der Techniker ein Ticket für eine SW-Änderung aus, wir müssen dieses Update in das Benutzerhandbuch aufnehmen und notieren, wer die Änderung vorgenommen hat, wann und was der Grund für diese Änderung ist (dh mit welchem ​​Ticket verknüpft). Ich denke an ein Tool, das modulares Schreiben unterstützt und den Änderungsverlauf nach Modulen erfasst. Mache ich es klarer? Vielen Dank
Hallo @xifeng, hast du SharePoint?
Ja. Wir haben SharePoint.

Antworten (3)

Für die interne Dokumentation habe ich Wikis als recht nützlich empfunden. Ein Wiki hat mehrere nützliche Funktionen für diese Aufgabe:

  • eingebaute Änderungsverfolgung
  • doc kann zur einfacheren Verwaltung in mehrere Seiten (z. B. eine pro Hauptabschnitt) strukturiert werden; einzelne Seiten können dann bearbeitet werden, ohne dass Änderungen in einem Masterdokument zusammengeführt werden müssen
  • einige (die meisten?) Wiki-Plattformen erkennen bevorstehende Bearbeitungskonflikte; Wenn jemand anderes die Seite zum Bearbeiten geöffnet hat, werden Sie es herausfinden (also keine unordentlichen Zusammenführungen später)
  • kann von jedem mit einem Browser auf jedem Gerät aufgerufen werden (versuchen Sie, ein Word-Dokument oder eine PDF-Datei auf Ihrem Telefon zu lesen ...)
  • Wenn Ihr Wiki eine Seite „Letzte Änderungen“ führt, ist die Arbeit sichtbar und erhält daher mit größerer Wahrscheinlichkeit zusätzliche hilfreiche Änderungen oder Kommentare (mehr Zusammenarbeit).

Es hat einige Nachteile – Sie müssen einen Server betreiben und das Drucken ist nicht sehr praktisch. Wenn Sie sich jemals entschieden haben, die Dokumentation für ein breiteres Publikum zu veröffentlichen, müssen Sie sie auf etwas portieren. Aber das heißt, Sie könnten wahrscheinlich das meiste davon skripten.

Absolut - das kam mir sofort in den Sinn. Stellen Sie nur sicher, dass Sie ein benutzerfreundliches, aktuelles Inhaltsverzeichnis/Index führen, da diese nicht automatisch erstellt werden (oder was automatisch erstellt wird, ist alles andere als benutzerfreundlich) und das Wiki wird ein großartiges Werkzeug sein. Insbesondere wenn das Wiki für den internen Gebrauch bestimmt ist, erlauben Sie Benutzeränderungen. Sie steuern häufig gute Tipps zu Nutzungsmustern bei, an die die Entwickler nicht einmal gedacht haben, und die Diskussionsseiten ersparen dem internen Helpdesk viel Kopfzerbrechen, da sich die Benutzer gegenseitig anleiten können.
Ach ja, ein Inhaltsverzeichnis braucht man auf jeden Fall, sonst verwandelt es sich in eine digitale Ramschschublade. :-)
Zum Drucken: Einige Wiki-Plattformen haben eine Option "Als PDF exportieren", was dafür gut ist.
@MartinMcCallion klingt praktisch! Weißt du zufällig welche? Ist dies nur pro Seite oder nehmen einige eine Seitenhierarchie und bündeln sie in einem PDF?
Diejenige, die wir bei der Arbeit verwenden, ist Confluence von Atlassian. Es ist jedoch nicht kostenlos, außer vielleicht für eine eingeschränkte Version. Und ich denke, Sie können es dazu bringen, so etwas wie ein PDF von "dieser Seite und allen darunter" zu erstellen. Aber ganz sicher bin ich mir da nicht.

In der Vergangenheit habe ich ein Wiki für diese Art von Arbeit verwendet. Ein Tool organisiert sich jedoch nicht von selbst. Die besten Wiki-Sites werden auf jeder Ebene vom Text bis zur Entwicklung stark bearbeitet.

Würde GoogleDocs funktionieren? Wir haben sie ausgiebig an meinem früheren Arbeitsplatz (einer Universität) verwendet, da jeder ein Google-Konto hatte, das das Campus-E-Mail-Konto war, und es eine gute Versionsverfolgung hat.

Wie bei jedem gemeinsam genutzten Dokument benötigen Sie normalerweise jemanden, der sich darum kümmert, ob Teile nicht aktualisiert werden und dies tun sollten, und um sicherzustellen, dass das Inhaltsverzeichnis/der Index aktuell ist.

Leider sind an meinem derzeitigen Arbeitsplatz Gmail und GDocs nicht erlaubt. Es gibt im Allgemeinen auch nicht viel Innovation, daher haben wir keine immer aktualisierten Dokumente für mehrere Benutzer (zumindest in den Abteilungen, mit denen ich interagiert habe).

Bestes Tool zum Erstellen von Benutzerhandbüchern
AntwortenHierDatenschutz-Bestimmungen1y, 0v