Sollte die Beta-Funktionalität in einem Schulungshandbuch erwähnt werden?

Ich schreibe Schulungshandbücher für ein Softwareprodukt. Wenn dieses Produkt das nächste Mal veröffentlicht wird, wird eines der darin enthaltenen Tools als „in Beta“ gekennzeichnet. dh diese Funktionalität ist nur als technische Vorschau enthalten.

Die Produktdokumentation wird diese Funktionalität sicherlich enthalten, aber sollte ein Schulungshandbuch? Die Funktionalität wird die Benutzererfahrung erheblich verbessern, unterliegt jedoch offensichtlich Änderungen und Aktualisierungen.

Ist es also eine bewährte Methode, Benutzer darin zu schulen, ein Tool zu verwenden, das sich noch in der Beta-Phase befindet, oder es einfach zu ignorieren, unabhängig davon, wie nützlich es ist?

Ich würde sagen, dass dies weitgehend vom Veröffentlichungszyklus Ihres Produkts abhängt. Wenn die „endgültige“ Version der Funktion beispielsweise in einem Monat ausgeliefert wird, ist die Aktualisierung der Schulung möglicherweise zu kostspielig. Doch auf die finale Version müssen die Nutzer ein Jahr warten, an die Beta dürften sie sich sowieso gewöhnen.
Reden Sie davon, etwas als Beta zu kennzeichnen?
Vielen Dank für alle Ihre Antworten an alle. Ich denke, es besteht allgemeine Einigkeit darüber, dass wir nicht für den Hauptteil veränderbare Funktionen trainieren sollten, sondern einen Anhang zum Handbuch hinzufügen sollten. Die Idee gefällt mir sehr gut und passt gut dazu. Ich denke, ich werde damit gehen. Was es für uns kompliziert macht, ist, dass wir nicht sicher sind, wann es aus der Beta herauskommen wird – es könnte 2 Monate dauern, es könnte ein Jahr sein. Wie auch immer, nochmals vielen Dank, auch wenn ich Ihre Antwort nicht als am hilfreichsten ausgewählt habe!

Antworten (9)

Normalerweise füge ich einen deutlich gekennzeichneten Abschnitt "Beta-Funktionen" hinzu . (entweder insgesamt gebündelt, oder in einzelnen Abschnitten als "Nur BETA" gekennzeichnet).

Dies ermöglicht es Nicht-BETA-Benutzern, es zu überspringen, und eliminiert Leute, die sich über das Fehlen von BETA-Funktionen in der PROD-Version beschweren.

Investieren Sie dann weniger Aufwand in den BETA-Bereich, wenn Sie beabsichtigen, ihn früh und häufig zu ändern (da das Produkt schnell und die Dokumentation ebenso schnell aktualisiert wird), ODER mehr Aufwand, wenn Sie mit einer langsameren Änderungsrate rechnen.

+1 - Man sollte normalerweise früh dokumentieren (mit Vorbehalten), anstatt Lücken zu lassen. Bekanntlich blieb GMail fünf Jahre lang in der Beta -Phase – stellen Sie sich vor, was passieren würde, wenn eine einigermaßen stabile Funktion undokumentiert bliebe, nur weil die Unternehmensbürokratie sich nicht von einem Beta- Label entfernt hatte

Dies hängt davon ab, wie wahrscheinlich es ist, dass Sie ein neues Schulungshandbuch veröffentlichen, wenn die Funktion die Betaphase verlässt.

Wenn Sie Ihre Schulungsmaterialien regelmäßig aktualisieren, sodass alle Änderungen an der Beta-Funktion mit einem aktualisierten Handbuch einhergehen, und Ihre Benutzer die aktualisierten Handbücher verwenden, dann schadet es wenig, Benutzer auf hilfreiche Funktionen hinzuweisen, sofern dies erfolgt sehr deutlich, dass sich das Feature derzeit in der Beta-Phase befindet.

Wenn es wahrscheinlich ist, dass aktualisierte Handbücher Ihren Benutzern nicht zur Verfügung gestellt werden, ist es am besten, Verweise auf Funktionen, die sich wahrscheinlich ändern werden, aus der Schulungsliteratur herauszuhalten, bis sie fertiggestellt sind.

Wenn die Funktion äußerst nützlich ist, können Sie am Ende des Handbuchs immer darauf verweisen, zusammen mit Links zu einer ausführlicheren Dokumentation als zusätzliche Lektüre.

Wenn die Beta-Funktion komplex genug ist, um spezielle Anweisungen zu erfordern, ist es möglicherweise eine gute Idee, ein separates Dokument zu veröffentlichen, das das Beta-Schulungsdokument für die Funktion ist. Auf diese Weise erhalten Sie Anweisungen und erhalten Feedback dazu, wie Benutzer am besten in die Verwendung eingewiesen werden können, bevor Sie die Funktion in das reguläre Training integrieren.

Ich schlage vor, dass Sie dem Drang widerstehen, Kunden in Betafunktionen zu schulen, es sei denn, sie nehmen ausdrücklich an Ihrer Beta teil. Basieren Sie Ihr Standardtraining nur auf veröffentlichten Versionen.

Das heißt nicht, dass Sie die Schulungsinhalte nicht erstellen können, sondern nur noch nicht in die endgültigen Ergebnisse aufnehmen. Wenn Sie eine Single-Sourcing-Lösung verwenden, können Sie dies auf verschiedene Weise erreichen.

Vielleicht möchten Sie diese Auszubildenden in Ihrer Nähe haben und sie einladen, neue Funktionen zu testen, aber ihnen sollte klar sein, dass sich diese Aktivität von der regulären Schulung unterscheidet. Dies setzt eine Vor-Ort-Schulung voraus, springen Sie nicht in ein Webinar, sonst riskieren Sie, die Grenzen zu verwischen.

"...oder Sie riskieren, die Grenzen zu verwischen" Dies scheint hier entscheidend zu sein. Eine klare Abgrenzung dessen, was endgültige Funktionalität und was Beta ist, ist wirklich, wirklich wichtig.

Ich würde sagen, betrachten Sie dies aus der Sicht des Kunden. Wenn sie wahrscheinlich während des Trainings auf diese Funktionalität stoßen, diese Funktion wünschen und sich möglicherweise ärgern, wenn sie diese Funktion nicht im Schulungshandbuch sehen, dann würde ich sie auf jeden Fall hinzufügen.

Ich mag die Idee von @sphenning, Informationen über die Funktionalität am Ende des Schulungsdokuments zu haben. Vielleicht eine einzeilige Erwähnung im Hauptinhalt mit einem Link zum Inhalt am Ende. Dies kann Ihnen die Aktualisierung erleichtern und dem Benutzer gegenüber betonen, dass es sich um eine Betaversion handelt.

In einer solchen Situation ist mein erster Instinkt, mich mit meinem Produktmanager zu beraten, um sicherzustellen, dass er oder sie damit einverstanden ist, auf solche Funktionen hinzuweisen. Da die Funktion allgemein verfügbar sein wird, würde ich sie allen Dokumenten hinzufügen.

Wenn Sie es überhaupt hinzufügen, fügen Sie es als Anhang hinzu.

Ein Anhang zum Haupthandbuch weist darauf hin, dass es kein vollständiger Bestandteil des Produkts ist.

Wenn es die Beta-Funktionalität in das Hauptprodukt schafft, können Sie den Abschnitt auch in das Haupthandbuch verschieben. Wenn es aus dem Produkt entfernt wird, löschen Sie den Anhang ohne Auswirkung auf das Haupthandbuch.

Ich würde sagen, Sie erstellen eine Entwurfsversion des Dokuments mit enthaltenen Beta-Funktionen, die jedoch mit etwas gekennzeichnet ist, das darauf hinweist, dass es sich um eine Beta-Funktion handelt. Dann kann das Dokument mit der Beta-Software verteilt werden.

Sobald eine neue Produktionsversion gesperrt ist, können Sie Ihre Entwurfsversion einfach durchgehen und nach jeder Beta-Funktion suchen, um:

  1. Entfernen Sie die Beta-Symbole für die Funktionen, die unverändert in die Produktion verschoben wurden
  2. Aktualisieren Sie die Dokumentation für alle Funktionen mit Änderungen, die während des Betatests vorgenommen wurden
  3. Entfernen Sie alle Funktionen, die es nicht von der Beta in die Produktion geschafft haben

Indem Sie die Arbeit noch in der Beta-Phase beginnen, können Sie den Übergang zu einer neuen Version des Produktionsdokuments beschleunigen, aber Sie betonen immer noch die Tatsache, dass Funktionen es nicht unbedingt bis zum Ende in die Produktion schaffen werden.

Beta-Funktionen sollten nur in Beta-Dokumenten erwähnt werden, die eindeutig als solche gekennzeichnet sein sollten.

Die Schulungsmaterialien sollten die in der Schulung verwendete Version widerspiegeln. Wenn das Training für eine Release-Version ist, könnten Sie ein Modul „Vorschau auf kommende Attraktionen“ hinzufügen, um Dinge in einer Beta-Version abzudecken, aber zuerst „zukunftsgerichtete Aussagen“ googeln.

Ich würde ein universelles Schulungshandbuch für alle Arten von Endbenutzern führen, um zu vermeiden, dass Sie sich Gedanken über separate Inhalte für Beta- und Nicht-Beta-Benutzer machen müssen, wenn Ihr Produkt live geht und keine Beta mehr. Betafunktionen sollten jedoch in anderen Arten von Benutzerkommunikation hervorgehoben werden, z. B. in Neuigkeiten oder Versionshinweisen.