Gute Referenzen für Beispiele für Endbenutzerdokumentationen und Hinweise [geschlossen]

Unsere hauseigene Software wurde für viele Benutzer verwendet, und die Schulungsabteilung bat uns um Tipps zum Format der Endbenutzerdokumentation.

Weiß jemand, wo ich gute Beispiele für Software-Endbenutzerdokumentation finden kann, die eine Schulungsabteilung zur Inspiration verwenden kann, oder Websites mit guten Ratschlägen?

Dies ähnelt dieser Frage, ich suche jedoch nach einer Endbenutzerdokumentation für nicht technische Benutzer.

Vielleicht möchten Sie zunächst Ihre internen Benutzer zu der Software befragen und herausfinden, welche Informationen sie wissen möchten.

Ein Großteil der Dokumentation, die ich über Software geschrieben habe, hat ein oder mehrere Zielgruppen im Auge. Ihre Schulungsabteilung würde wahrscheinlich von einem Skelett von Themen (wie einem Inhaltsverzeichnis) profitieren. Dann könnten Sie diskutieren, welche Themen relevant und welche für ihre Trainingsziele irrelevant sind.

Einige der Themen könnten Folgendes abdecken:

1. Zielpublikum)
2. Technische Anforderungen
3. Installation (falls zutreffend)
4. Prozess (dh welche Geschäftsfunktion erfüllt die Software?)
5. Featureset (Welche Funktionen hat die Software?)
   • Sie können hierfür einen aufgabenbasierten Ansatz wählen, z. B. Benutzer hinzufügen oder Dokument hinzufügen
   • Sie könnten einen objektbasierten Ansatz verfolgen, z. B. Benutzer, Rollen
   • Sie können einen menübasierten Ansatz verwenden, z. B. Menü Datei, Menü Ansicht
6. Schließlich kann möglicherweise ein Abschnitt mit den kommenden Funktionen und häufig gestellten Fragen als wachsendes Wissensrepository für Ihr Produkt dienen.

Versuchen Sie vorauszusehen, wie Ihre Endbenutzer Ihre Software verwenden, basierend auf Ihrem Wissen über deren Entwicklung, Ihrem Wissen darüber, was sie tut, und auch basierend auf (hoffentlich) Ihren Interviews mit Endbenutzern.

Versuchen Sie vor allem, eine Dokumentation zu erstellen, die Sie lesen möchten, verwenden Sie unterhaltsame Beispielnamen, um sie zu demonstrieren, und verwenden Sie viele kommentierte Screenshots.

Hoffe das hilft

Ich habe mehrere "Endbenutzerhandbücher" gelesen und eines geschrieben, und ich denke, dass es viele Elemente gibt, die ihre Wirksamkeit verbessern:

• Zeigen Sie mit Bildern, wie ein Befehl ausgegeben oder eine Aktion ausgeführt wird (z. B. Screenshots).
• Konzentrieren Sie sich auf die Notwendigkeit, etwas zu tun, und auf den Weg, es zu erledigen. Vermeiden Sie technische Beschreibungen darüber, wie optimiert diese Aktion beispielsweise ist.
• Nachdem ich ein Flussdiagramm erstellt hatte, in dem die Module beschrieben wurden, wurde die Software aufgeteilt, und ich erhielt Kommentare, dass dies nicht sehr nützlich war.
• Versuchen Sie, die möglichen Probleme eines Benutzers vorherzusehen, damit Ihr Abschnitt zur Fehlerbehebung hilfreich wird. Sie müssen Ihr Programm auch mit Benutzern testen, die nicht an der Entwicklung beteiligt waren, selbst mit Ihren Mitarbeitern, die an anderen Projekten teilgenommen haben.
• Vermeiden Sie langweilige Beschreibungen. Alle weiteren Informationen können in einen Anhang oder ähnliches eingefügt werden.

Ich hoffe, dass dies für Sie nützlich sein kann.

Sie erwähnen, dass es für das Training verwendet wird.

Wenn Sie eher nach einem Schulungsdokument als nach einem Referenzdokument suchen, ist Joel Spolskys Tutorial zu Mercurial hier meine Lieblingsseite .

1. Einfache, saubere Präsentation. Es ist schön anzusehen.
2. Autoritativ, aber persönlich im Ton. Es fühlt sich an, als ob Sie in einem großartigen College-Vortrag sind.
3. Einfache Bilder, nicht viele Screenshots. Lesen Sie auf der Rückseite der Serviette, warum dies funktioniert.

Wenn Ihr Trainingsdokument halb so cool wäre wie Joels Mercurial-Tutorial, würde ich es lesen. Aber Sie brauchen jemanden mit a) einer Leidenschaft für das Schreiben und b) einer unglaublichen Tiefe an Wissen, um es zu schaffen, selbst wenn Sie die 3 oben genannten Punkte kopieren könnten. Hoffe, es funktioniert.

Ich weiß nicht, ob dies möglicherweise Ihren Anforderungen entspricht, aber es gibt Systeme für die technische Dokumentation von Sphinx , die mir in den Sinn kommen und die Erstellung einer Online-Dokumentation erleichtern. Könnte so etwas für das verwendet werden, woran Sie interessiert sind?

Ich bin auch gerade auf ReadTheDocs gestoßen, das fast das Gleiche tut, aber eine gehostete Lösung ist.

Schauen Sie sich die Society for Technical Communication (STC) an . Viele ihrer Preisträger haben eine Produktion geschrieben, die allgemein verfügbar ist. Möglicherweise sind auch Muster verfügbar. Wenn Sie Mitglied werden, erhalten Sie auch Zugang zu einer größeren Anzahl von Informationen.