Zahlreiche SaaS-Technologieunternehmen kämpfen mit dem Prozess der Entwicklung und Verteilung von Produktdokumentation (Benutzerhandbücher, Bedienungsanleitungen und/oder Tutorials) an ihre Kunden.
Oftmals liegt dies an mangelnden Kenntnissen oder Prozessen über die ordnungsgemäße Handhabung und Erstellung von Handbüchern oder sogar daran, wer für diese verantwortlich ist.
Solange es den Bedarf an Werkzeugen und Software in dieser Welt gibt, werden wir eine effektive Kommunikation benötigen, um anderen die Verwendung, Entwicklung, Funktionsweise und Architektur dieser Güter effektiv zu vermitteln. Wenn Sie sich fragen, warum das so ist, ist die Antwort einfach. Es liegt daran, dass technische Kommunikationsfähigkeiten entscheidend sind, um Informationen zu sammeln und es dem Publikum zu ermöglichen, das Produkt oder die Technologie besser zu verstehen.
Während die Kommunikation in der realen Welt durch Sprache, Körpersprache und Gefühlsäußerungen erfolgt, findet die technische Kommunikation in der virtuellen Welt durch technische Produktdokumentation statt!
Das einzige Ziel der technischen Produktdokumentation ist es, dem Benutzer das Verständnis für die Funktionsweise und Architektur eines Produkts oder einer Technologie zu erleichtern. Es handelt sich eher um ein Handbuch für neue Mitarbeiter, Benutzer/Kunden und alle anderen, die mit den Arbeitsmethoden vertraut sein müssen, um eine gründliche Beschreibung der Funktionsweise eines Produkts!
Es ist die Aufgabe des Produktmanagers, ein Team aufzubauen, das eine ausgefeilte Produktdokumentation erstellt, verwaltet, veröffentlicht und pflegt.
Ich bin sicher, dass jeder Produktmanager in seiner Abteilung schon einmal Folgendes gesagt oder gehört hat: "Die Produktdokumentation ist Bestandteil der Pflichten des Product Owners"; "Jedes Entwicklungsteam sollte seine eigenen Anwendungen dokumentieren"; "Die Funktion wurde bereitgestellt, wurde das Handbuch aktualisiert?" oder, viel schlimmer noch, "es gibt einen Fehler in der technischen Dokumentation".
Es ist klar, dass die technische Produktdokumentation ein wenig rätselhaft sein kann, so einfach sie auch scheint! Während Einzelpersonen versuchen, die oben genannten Probleme zu lösen oder darüber zu streiten, verschlechtern sich Handbücher und Anleitungen, was dem Image Ihres "Produkts/Unternehmens" schadet.
Um allen, die mit ähnlichen Problemen konfrontiert sind, zu helfen, finden Sie hier einige Verfahren, die Sie zur Optimierung Ihrer Produktdokumentation einsetzen können.
Was ist der Zweck einer Produktdokumentation?
Wenn Sie von Produktdokumentation für ein technisches Produkt oder eine Dienstleistung sprechen, meinen Sie damit die Informationen, die es beschreiben, und die Daten, die dazu gehören.
Bei der technischen Dokumentation oder Produktdokumentation geht es darum, dass Ihr Publikum und Ihre Kunden Ihr Produkt nutzen, lesen, verstehen und verwenden können. Die meisten Produktdokumentationen werden natürlich in verschiedenen Bereichen wie Technik, Medizin, Informationstechnologie und Marketing erstellt.
Eine gute technische Produktdokumentation hilft Ihrem Publikum, sich in Ihrem Produkt zurechtzufinden und es ohne Komplikationen zu nutzen.
Eine weitere Überlegung ist, dass die technische Dokumentation entscheidend für die Unterstützung der Kunden ist und wesentlich zur Markenbildung und zum Vertrauen Ihres Unternehmens beiträgt. Wenn sie es am nötigsten brauchen, suchen die Benutzer nach technischer Dokumentation. Die Zielgruppe nutzt Ihr Produkt, um sich über die Prozesse zu informieren und Probleme zu lösen.
Das bedeutet, dass eine gründliche und umfassende Produktdokumentation, die dynamisch ist und Suchfunktionen enthält, sehr wichtig ist.
Was sind die verschiedenen Produktdokumentationen?
In diesem Abschnitt können Sie sehen, welche Art von Produktdokumentation Sie für Ihre Kunden oder Auftraggeber benötigen.
Es gibt viele verschiedene Arten von Produktdokumentation, die den Anforderungen verschiedener Anwendungsfälle und Benutzerbedürfnisse entsprechen:
Produkt-Benutzerdokumentation: Diese besteht aus Benutzerhandbüchern, Anleitungen, Tutorials, FAQs, Versionshinweisen und Schulungshandbüchern sowie Betriebsverfahren.
Unternehmensdokumentation: Umfragen zeigen, dass mehr als 8 von 10 Unternehmen von 1000 befragten Unternehmen formelle Richtlinien und Verfahrenshandbücher verwenden.
Es gibt noch viele andere Unternehmensdokumente, die sich auf Unternehmensrichtlinien und -verfahren beziehen, wie in der obigen Untersuchung festgestellt wurde, sowie Anleitungshandbücher, technische Verfahren, Verhaltens- und Ethikdokumente. Außerdem gibt es eine juristische Dokumentation, die durch ein Passwort geschützt werden kann. Auch Unternehmensstrukturen, bewährte Praktiken und Verfahren sowie Wartungshandbücher
Entwicklerdokumentation: Diese Art von Dokumentation enthält Anweisungen für die Entwicklung von Softwareprodukten, funktionale Spezifikationen, technische Spezifikationen, Dokumentationen und Werkzeuge zur Unterstützung der Arbeitsabläufe der Entwickler.
Nachdem wir nun ein besseres Verständnis der verschiedenen Arten von technischer und Produktdokumentation haben, wollen wir erörtern, womit die ersten Schritte eines soliden Managements des Entwicklungsprozesses der Produktdokumentation beginnen.
Finden Sie einen Leiter für die Entwicklung der Produktdokumentation.
Ein sehr typisches Problem ist die Frage, wer für die Produktdokumentation verantwortlich sein soll, und zwar nicht als jemand, der sie nur aktualisiert, sondern als jemand, der für die Qualität und den Erfolg des Produkts verantwortlich ist.
Manche Unternehmen sind der Meinung, dass jeder Produkteigentümer und/oder Produktmanager für die Produktdokumentation verantwortlich ist, aber auch andere Abteilungen wie die Entwicklung und der Support können mit der Verantwortung betraut werden, Benutzerhandbücher, Bedienungsanleitungen und alle Facetten der Produktdokumentation aktuell und effektiv zu halten.
Die Entwicklung der Produktdokumentation hat viele bewegliche Teile, von denen wir hier nur zwei herausgreifen wollen:
-
Wer versteht, wie das Produkt auf allen Ebenen funktioniert (dazu gehören auch die Produktentwicklungs- und Spezifikationsteams).
-
Diejenigen, die Input von Kunden erhalten, die die Produktdokumentation durchgehen und sich deren Schwierigkeiten, Rückmeldungen und Bedenken bezüglich des Verständnisses der vorliegenden Produktdokumentation anhören.
Der erste Teil hilft uns bei der Erstellung der zugewiesenen Produktdokumentation mit dem vorhandenen Wissen, und diese wird an die Kunden geschickt, die im Gegenzug Feedback geben und den zweiten Prozess einleiten, der zur Optimierung der Dokumentation beiträgt.
Manchmal sind diese beiden Punkte nicht perfekt aufeinander abgestimmt, und das führt dazu, dass die Produktdokumentation nie die notwendige Aufmerksamkeit erhält.
Ein Ansatz besteht darin, eine Person zu benennen, die für die "Leistung" der Produktdokumentation, der Produkthandbücher und der Bedienungsanleitungen verantwortlich ist. Stellen Sie sich eine Bestellung vor, bei der "Produktdokumentation" als Produkt angegeben ist. Er ist dafür verantwortlich, alle Teams des Unternehmens durchzugehen, zu skizzieren, wie jedes Produkt seine Handbücher erstellt und die mit diesem Prozess verbundenen Herausforderungen zu identifizieren.
Es ist nicht beabsichtigt, dass dieser Produkteigentümer und Produktmanager vollständig für die Erstellung und Änderung von Handbüchern verantwortlich ist, sondern dass er die Personen in den einzelnen Teams bei der Dokumentenverwaltung unterstützt.
Diese Person sollte untersuchen, wie die Benutzer mit den Dokumenten interagieren, Möglichkeiten für flüssigere Aktualisierungen vorschlagen und Feedback einholen, um festzustellen, wie die Dokumentation und die Erklärungen zu den einzelnen Produkten bei den jeweiligen Zielgruppen verbessert werden können.
Eine Person, die für alle Facetten der Produktdokumentation verantwortlich ist, die den Arbeitsablauf und die verschiedenen Abteilungen, die diese Dokumentation erstellen müssen, verwaltet, wird die Produktivität innerhalb des Unternehmens steigern, das Bewusstsein für das Produkt schärfen und die Kunden mit Wissensportalen über das Produkt aufklären und insgesamt das Produktverständnis rationalisieren.
Betrachten Sie Ihre Produktdokumentation als das Produkt selbst.
Produkte sind dazu da, einen bestimmten Wert zu liefern, der die Erwartungen des Kunden erfüllt oder übertrifft. Ausgehend von Statistiken von D2WorldWide bewerten 73,7 % der Menschen die Dokumentation als hilfreicher als Videos, Verpackungen oder Verkäufer, wenn sie Informationen über Produkte suchen, deren Kauf sie in Erwägung ziehen.
Berücksichtigen Sie die Faktoren, die zur Attraktivität eines Produkts beitragen. Es gibt mehrere Faktoren, die die Attraktivität eines Produkts beeinflussen können, aber für diesen Artikel konzentrieren wir uns auf drei. Sie übertreffen die Erwartungen in Bezug auf den Wert; ihre Nutzung erzeugt Zufriedenheit; und sie sind wettbewerbsfähig.
Dieselben Konzepte gelten auch für eine gute Online-Produktdokumentation. Produktdokumente, die "über den erwarteten Wert" hinausgehen, zeigen nicht nur, wie der angegebene Gegenstand zu verwenden ist, sondern bieten auch Lösungen an, die dem Kunden nicht bekannt sind oder die er nicht für möglich hält. Es ist immer wichtig zu sehen, wie andere Unternehmen ihre Produktdokumentation erstellen, um aus ihren Erfolgen und Fehlern zu lernen.
Es ist sinnlos, ein Unternehmen zu haben, das einzigartige und qualitativ hochwertige Software entwickelt, die der Konkurrenz voraus ist, wenn die Entwickler und Kunden, die Ihre technischen Produktdokumente integrieren, nicht in der Lage sind, sie zu verstehen.
Bedenken Sie, dass die Person, die die Produktdokumentation liest, möglicherweise nicht mit der Bandbreite möglicher Lösungen, die das Produkt bietet, oder mit dem Markt vertraut ist (wie es bei technischen SaaS-Produkten häufig der Fall ist), und daher muss sie über diese Lösungen und verschiedene Optionen im Zusammenhang mit dem Produkt "aufgeklärt" werden.
Produktdokumente, deren "Benutzerfreundlichkeit Zufriedenheit erzeugt", folgen einem logischen, für die Zielgruppe geeigneten Lesemuster. Es nützt nichts, das ausführlichste Handbuch der Welt zu haben, wenn es ein 500-seitiges PDF ist oder kein Code-Beispiel enthält und nicht dynamisch mit Suchmöglichkeiten und anderen Funktionen erstellt wurde. Sammeln Sie das Feedback der Benutzer Ihres Produktdokuments und Ihres Supportpersonals. Sie werden feststellen, wo die größten Probleme im Zusammenhang mit den gemeldeten Daten liegen.
Wettbewerbsfähige Produktdokumentationen sind solche, die unter Verwendung der effektivsten Techniken zum Informationsaustausch ständig aktualisiert werden. Sie verfügen über erstaunliche Funktionen wie eingebaute Suchfunktionen, Übersetzungen, verschiedene Versionen, eingebettete Bilder, Videos und vieles mehr!
Selbst wenn Ihr Integrationshandbuch das am besten geschriebene aller Technologieunternehmen ist, wird es ohne ein hinzugefügtes Video, Bilder und Codes, die per Copy & Paste eingefügt werden können, um die Nutzung für Ihre technisch versierten Kunden, die Ihre technischen SaaS-Produkte kaufen, zu erleichtern, nicht attraktiv genug sein.
Es ist immer wichtig, zu sehen, wie andere Unternehmen ihre Dokumente einführen, um von ihren Erfolgen und Fehlern zu lernen.
Es ist sinnlos, ein Unternehmen zu haben, das einzigartige und hochwertige Software entwickelt, die der Konkurrenz voraus ist, wenn die Entwickler und Kunden, die Ihre Dokumente integrieren, nicht in der Lage sind, sie in ihrer Gesamtheit zu erfassen.
Rückmeldung zur Produktdokumentation
Effektive technische Produktdokumentation verbessert die Erfahrung des Endbenutzers, indem sie den Prozess des Produktverständnisses und der Problemdiagnose mit leicht zugänglichen schriftlichen Lösungen verfeinert. Wenn die Kunden Vertrauen in Ihre Produkte haben und wissen, wie sie zu verwenden sind, werden sie bei Bedarf auch in Zukunft auf Sie zurückkommen.
Eine neue Studie von SDL zeigt, dass die Bedeutung der Dokumentation auf den weltweiten Märkten zunimmt. Die Untersuchung zeigt, dass etwa 53 % der Käufer ihre Einkäufe anhand von Fachliteratur tätigen, bevor sie das Produkt überhaupt ausprobieren. Eine weitere Statistik aus dieser Untersuchung zeigt, dass 94 % der Käufer Produktinformationen an einem einzigen Ort für hilfreich und nützlich halten. Aus diesem Grund legt heute jedes Unternehmen den gleichen Wert auf die Produktdokumentation wie auf die Produktentwicklung oder -prüfung.
Selbst wenn es einen Verantwortlichen für die Dokumentation gibt, der das Dokumentationsteam leitet und eine Produktdokumentation erstellt hat, die im Hinblick auf eine verbesserte Benutzerfreundlichkeit überarbeitet und bewertet wurde und die ordnungsgemäß aktualisiert wurde, haben Sie immer noch Schwierigkeiten, Ihren Benutzern und Verbrauchern das Verständnis für Ihre technischen Produkte zu vermitteln. Dies kann darauf zurückzuführen sein, dass die Benutzer/Leser nicht verstehen, wie Ihre Dokumente gelesen werden oder welche Fragen sie wirklich stellen. Einer der schwierigsten Aspekte beim Verfassen von Dokumenten ist es daher, sich in die Lage des Lesers zu versetzen. Schließlich sollte derjenige, der die Produktdokumentation erstellt, ein solides Verständnis für das Produkt haben.
Dieses Fachwissen kann den Verfasser dazu veranlassen, Dinge zu übersehen, die für den durchschnittlichen Benutzer nicht so offensichtlich sind. Dies ist typischerweise dann der Fall, wenn etwas, das für die Ersteller des Produkts selbstverständlich ist, für die Käufer und Benutzer des Produkts nicht ganz klar ist.
Dies kann auf verschiedene Weise geschehen:
Schreibstruktur oder -form: Auch wenn dies ein subjektiver Begriff zu sein scheint, kann schon die Art und Weise, wie ein Handbuch geschrieben ist, Verwirrung stiften. Es ist von entscheidender Bedeutung, die Art des Lesers zu identifizieren, der die Dokumentation liest; andernfalls kann es zu Äußerungen wie "Entwickler bevorzugen Beispiele gegenüber beschreibendem Text" oder "Unsere Dokumentation ist trotz des Vorhandenseins von Beispielen und visuellen Darstellungen nicht klar" kommen.
Themengliederung in Handbüchern: Gelegentlich entwickeln Unternehmen, die auf demselben Markt tätig sind, ein standardisiertes Dokumentationsformat. Wenn sich Ihre Unternehmensleitfäden nicht daran halten, kann dies beim Leser ein Gefühl der Fremdheit hervorrufen.
Übermäßige Verwendung impliziter Begriffe: In einem Handbuch können Abkürzungen wenig Sinn ergeben, selbst wenn es sich nicht um Akronyme handelt. Es ist schwer zu erkennen, aber einige Wörter, wie "Status", "ID", "Referenzen", und enthalten eine implizite Bedeutung, die als explizit getarnt ist. Verwenden Sie besondere Bezeichnungen wie "UserID" und nicht "UID".
Gültige Übersetzung: Die Übersetzung ist ein wichtiger Bestandteil der globalen Reichweite. Häufig erstellen Unternehmen schlecht übersetzte Benutzerhandbücher und Produktdokumentationen, die der Kultur bestimmter Länder nicht gerecht werden, oder die Wörter werden einfach nicht so übersetzt, wie es im Englischen für das betreffende Land der Fall wäre. Das Verständnis dieser feinen Nuancen kann die Produktdokumentation von unleserlichen Informationen zu einer umfassenden und übersetzten Produktdokumentation machen.
Um solche Situationen zu vermeiden, muss eine Lösung entwickelt werden, die das Feedback und die Navigationsmuster der Benutzer sammelt und analysiert.
Feedback-Tools wie Vocally a Docsie sind eine großartige Möglichkeit, Navigationsmuster zu erfassen und auszuwerten und zu untersuchen, wie Ihre Kunden Ihre Produktdokumentation sehen. Lernen Sie hier die 7 goldenen Regeln für die Erfassung von Feedback
Diese Informationen sind entscheidend für die Aktualisierung und Optimierung Ihrer Benutzerhandbücher, Bedienungsanleitungen und Produktdokumentationen, um Ihren Kunden eine nahtlose Erfahrung beim Kennenlernen Ihrer Produkte zu ermöglichen. Nichts ist frustrierender, als ein neues Produkt einzuführen und festzustellen, dass die Zahl der Supportanfragen aufgrund mangelhafter Anleitungen steigt.
Wie man eine umfassende Produktdokumentation schreibt
Qualitativ hochwertige Produktdokumentation ist fesselnd, nützlich und wirkungsvoll. Ich würde behaupten, dass eine geschickte Dokumentation ein notwendiger Bestandteil eines guten Produktmanagements ist. So sehr Produktmanager auch an der Entwicklung von Produkten beteiligt sind, ein wesentlicher Teil des Erfolges besteht darin, eine erstaunlich ausgefeilte Produktdokumentation zu erstellen, die unsere Kunden verstehen und nutzen können, um ihr Wissen über unsere Produkte zu erweitern.
Was ist mit den meisten Produktdokumentationen los?
Viele Produktmanager haben eine Abneigung gegen das Verfassen von Produktdokumenten. Die Produktdokumente, mit denen sie vertraut sind, kommen bei ihren Kunden möglicherweise nicht gut an, wenn nicht darauf geachtet wird, dass sie ansprechend, leicht zu lesen und verständlich sind.
Oft nehmen sich die Unternehmen jedoch nicht die nötige Zeit, um eine ansprechende Produktdokumentation zu erstellen und zu gestalten. Schlechte Produktdokumentation wird nur zu dem Zweck geschrieben, dass sie geschrieben wird. Sie verwendet weitschweifige Formulierungen, die mit vagen Gedanken gefüllt sind, und ein schlechtes Layout, das den Betrachter davon abhält, mit dem Material zu interagieren. Eine schlechte Produktdokumentation wird erstellt, um den Autor vor Kritik zu schützen, und ist eine völlige Verschwendung von jedermanns Zeit. Und auch die Kunden lesen sie aus diesem Grund nicht gerne.
Wie können wir das ändern und eine bessere Produktdokumentation schreiben, die unsere Kunden gerne lesen?
Exzellente Produktdokumentation ist mit der Absicht geschrieben, gelesen zu werden. Sie ist kurz und bündig. Eine gute Produktdokumentation ist gut formatiert und kann von jedem im Unternehmen oder von den Kunden in drei Minuten gelesen und verstanden werden. Sie vermeidet Fachjargon und gibt entweder den Standpunkt des Unternehmens wieder oder verweist auf diesen. Eine exzellente Produktdokumentation nimmt sich Zeit, um spezifische Anwendungsfälle zu skizzieren, die der Kunde verstehen und auf die erweiterte Nutzung des Produkts anwenden kann. Sie fesselt den Leser und lenkt die Aufmerksamkeit auf zugrundeliegende Probleme mit gut ausgearbeiteten Lösungen.
Die Stärke einer gut geschriebenen Produktdokumentation
Ob in kleinen, mittleren oder großen Unternehmen - gut formatierte technische Produktdokumente können viel Zeit sparen und den Mitarbeitern helfen, produktiver zu arbeiten. Dies gilt im Allgemeinen für die meisten produktbasierten Unternehmen, die einen großen Teil ihres Budgets für die Einstellung von technischen Redakteuren und die Erstellung technischer Produktdokumentation ausgeben.
Wenn in Ihrem Unternehmen mehr als zwei Personen mit der Erstellung von Produktdokumentation beschäftigt sind, lohnt es sich, eine Kultur der guten Dokumentation zu etablieren. Es gibt viele Gründe, warum Sie möchten, dass Ihr Team eine gut gestaltete Produktdokumentation erstellt, verwaltet und veröffentlicht, aber im folgenden Abschnitt werden wir uns damit befassen, wie eine effektive Produktdokumentation ein kostengünstiger Ansatz zur Verbesserung der Kundenerfahrung ist.
Effektive Produktdokumentation ist ein kostengünstiger Ansatz zur Verbesserung der Kundenerfahrung
Eine solide Kundenerfahrung ist das A und O, wenn es darum geht, loyale Kunden zu halten und zu pflegen. Die meisten Projektmanager sind Optimisten - sie haben ein Konzept, sind begeistert und führen es dann aus. Während Leidenschaft bewundernswert ist und die Ausführung produktiv erscheint, ist ein Spielplan vor der Ausführung einer angemessenen Produktdokumentation entscheidend.
Die ersten Schritte nach dem Brainstorming eines Spielplans bestehen darin, einen Design-Zyklus zu initiieren und den Inhalt der Produktdokumentation so zu strukturieren, dass er für die Kunden nach und nach leicht zu lesen ist.
Auch das Einholen von Kundenfeedback über die aktuelle Dokumentation ist ein wichtiger Schritt, um die Dokumentation entsprechend den Kundenbedürfnissen umzustrukturieren. Auf diese Weise können Projektmanager ihre Dokumentation mit Hilfe von Wahrnehmung und Automatisierung erstellen, verwalten, pflegen, veröffentlichen und optimieren. Dies ist keine einfache und unbedeutende Aufgabe, und es ist für den Erfolg unerlässlich, erstaunliche Werkzeuge wie Docsie zu haben, die einen Großteil der Prozesse für eine effektive Produktdokumentation automatisieren.
Eine ansprechende, ansprechende und übersichtliche technische Dokumentation hilft den Verbrauchern, das Produkt in kürzerer Zeit zu erlernen, was die Wahrscheinlichkeit erhöht, dass sie das Produkt korrekt einrichten und verwenden werden.
All diese Strategien zur Erstellung einer ausgefeilten Produktdokumentation führen im Wesentlichen zu höher bewerteten Produkten, positiveren Bewertungen und mehr Verkäufen; es versteht sich daher von selbst, dass die gesteigerten Verkäufe ein Ergebnis davon sind.
Wie man eine gut gestaltete Produktdokumentation erstellt
Wie kann man eine wirksame Dokumentation erstellen und eine Kultur fördern, in der sie zum Standard wird? Das Schreiben einer effektiven Dokumentation ist eine Herausforderung, aber es gibt viele gute Funktionen in Docsie , die dabei helfen können, diesen Prozess der Erstellung gut gestalteter und dynamischer Produktdokumentationsportale in Gang zu bringen. Im Folgenden finden Sie eine Zusammenfassung unserer Herangehensweise an dieses Thema.
Jetzt kann es losgehen:
Seitenbegrenzungen sorgen für Lesbarkeit. Ein gutes Dokument sollte nicht schwer zu lesen und geistig zu verarbeiten sein. Langwierige, mäandernde Sätze sind häufig ein Hinweis auf mangelnde Klarheit. Wenn die Mitteilung nicht auf einer einzigen Seite angemessen zusammengefasst werden kann, ist dies ein Hinweis darauf, dass der Produktmanager wahrscheinlich zurückgehen und die Situation weiter herunterbrechen sollte.
Formatierung verbessert die Qualität. Eine schlecht strukturierte Produktdokumentation erhöht die Wahrscheinlichkeit, dass der Schreiber es sich einfach machen wird. Erstellen Sie eine Vorlage mit gut formatierten Abschnitten, Tabellen und Dokumentüberschriften. Das ist eine einmalige Investition mit hohem Dividendenpotenzial.
Vorlagen helfen Ihnen, Zeit zu sparen. Es ist viel einfacher, einen Abschnitt aus einer Vorlage zu löschen, als daran zu denken, einen hinzuzufügen. Das ist nicht herablassend, sondern effektiv und zeitsparend. Einfache Abschnitte, die den Verfasser daran erinnern, mit dem allgemeinen Hintergrund zu beginnen und Messungen oder gefährliche Annahmen zu präzisieren, ermöglichen ein präziseres Schreiben und eine bessere Entscheidungshierarchie.
Kommentare und Aufgabenzuweisung Es gibt keinen sichereren Weg, Ihre Mitarbeiter von der Erstellung hochwertiger Unterlagen abzuhalten, als sie nicht zu kommentieren. Kommentare müssen nicht besonders klug sein; sie sollten vielmehr Engagement zeigen und als Vorbild dienen. Es ist zwar ideal, Feedback digital zu geben, damit andere im Unternehmen asynchron von der Konversation profitieren können, aber eine einfache Funktion in Docsie, die es Ihnen ermöglicht, Kommentare abzugeben und mit Ihrem Team zusammenzuarbeiten, ist für das Produktdokumentationsteam großartig!
In diesem Blog erfahren Sie mehr darüber, wie Docsie bei der Zusammenarbeit in der Produktdokumentation hilft
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/.
Die Dokumenttypen sollten skalierbar sein, um den Anforderungen Ihres Unternehmens gerecht zu werden. Da immer mehr Beteiligte in den Produktentwicklungsprozess einbezogen werden, muss die Kommunikation auf mehrere Dokumente aufgeteilt werden (insbesondere, wenn das Kriterium der "Prägnanz" von einer Seite erfüllt werden soll). Docsie bietet eine nützliche und nachhaltige Lösung für wachsende Produktdokumentationsteams.
Verwenden Sie Docsie als eine Möglichkeit, die Erstellung von Produktdokumentationen zu beschleunigen.
Docsie ist eine sehr praktische Plattform, die Ihnen bei jedem Aspekt der Erstellung von Produktdokumentationen und Wissensportalen hilft. Es verfügt über viele integrierte Funktionen, die das Erstellen, Veröffentlichen, Pflegen und Verwalten von Projekten zur Erstellung von Produktdokumentationen wirklich einfach machen und Spaß machen! Hier sind nur einige der vielen Funktionen von Docsie, die Ihnen helfen können, diese Ziele zu erreichen:
Bearbeitungsmöglichkeit: Docsie ermöglicht es allen Nutzern, die Produktdokumentation nach der Veröffentlichung zu bearbeiten, indem eine alternative Version erstellt wird, die erst dann live geht, wenn sie aktiv ist. Das ist großartig, denn die Produktmanagement-Teams können die Produktdokumentation bearbeiten und ändern und sie dann live schalten, sobald sie dazu bereit sind, ohne durch HTML- und CSS-Reifen springen zu müssen. Die Produktdokumentation wird auf Knopfdruck automatisch gerendert, wenn sie bereit ist.
Suchfunktion: Wenn Ihre Produktdokumentation sehr umfangreich ist oder viele Funktionen enthält, ist das Docsies-Such-Plugin ein nützlicher Bonus, der es Ihren Kunden ermöglicht, Ihre Dokumentation schnell und einfach zu durchsuchen, um die Informationen zu finden, die sie benötigen, um den Prozess zu beschleunigen, in dem sie die Informationen aus Ihrer Produktdokumentation ansehen und aufnehmen.
Verknüpfungsmöglichkeit: Docsie macht Ihre Produktdokumentation SEO-freundlich. Sie können auf bestimmte Seiten auf der Website Ihres Unternehmens verlinken oder einfach Schlüsselwörter zu Ihren Produkten schreiben, die online durchsuchbar sind und neue Kunden anziehen, die das gleiche Produkt suchen, das Sie im Angebot haben.
Möglichkeit verschiedener Übersetzungen: Docsies hochmoderner Ghost-Übersetzer ermöglicht es unseren Benutzern, ihre Produktdokumentation in verschiedene Sprachen zu übersetzen. Außerdem können Ihre Kunden mit der Sprachauswahlfunktion von Docsie die Sprache wählen, die ihnen am besten zusagt. Dies ist sehr nützlich für die globale Reichweite und die Erweiterung des Kundenstamms von Unternehmen, während gleichzeitig das Vertrauen mit neu gegründeten Kunden und Kunden im Ausland aufgebaut wird.
Fähigkeit, Aufgaben zuzuweisen und zu kommentieren für eine nahtlose Zusammenarbeit: Docsie verfügt über erstaunliche Tools für die Zusammenarbeit mit Ihrem Produktdokumentationsteam. Sie können Kommentare zuweisen, Aufgaben festlegen und Rollen zuweisen, damit Sie besser verwalten können, welche Aufgaben von welchem Benutzer, der mit Docsie an Ihrem Produktdokumentationsprojekt arbeitet, erledigt werden. Um mehr zu erfahren, lesen Sie diesen Blog hier
Feedback-Erzeugung: Nur wenn Sie wissen, was Ihre Kunden über Ihre Dokumentation denken, können Sie Ihre Produktdokumentation auf die Bedürfnisse Ihrer Kunden abstimmen, so dass diese Ihre Produktdokumentationen und Wissensportale besser verstehen können. Mehr über die Bedeutung von Produktdokumentations-Feedback erfahren Sie in meinem Blog hier.
Es gibt noch viele weitere Funktionen und Möglichkeiten, die Docsie Ihnen und Ihrem Produktmanagement-Team bietet, um eine hervorragende Produktdokumentation zu erstellen. In diesem Artikel möchte ich auf Plugins eingehen, die jedes Docsie-Wissensportal und jede Produktdokumentation ergänzen kann, um sie zu verbessern und die Benutzerfreundlichkeit insgesamt zu erhöhen.
Docsie-Plugins, um Ihr Dokumentationsportal dynamisch zu machen: Docsie hat eine Reihe von Plugins, die Sie verwenden können, um Ihre Dokumentation ansprechender zu gestalten. In diesem Blog werde ich sie in 3 Teile unterteilen.
In diesem Abschnitt werden wir die Erklärung dieser Wissensportal-Plugins in drei Teile unterteilen.
PART 1: Im ersten Teil werden wir zeigen, was wir zeigen, was die 'Display Version Picker', 'Display Language Picker', die 'Display Section Anchors' und die 'Display Footer Navigation'.
Teil 2: In diesem Teil zeigen wir das 'Code Highlighting', 'Search', und das 'Share to Social Network' Plugin
TEIL 3: Im dritten Teil zeigen wir die 'Bildvorschau', 'Dokument-Metadaten' und das 'Abschnitt automatisch hervorheben'-Plugin.
Bevor wir uns mit den Plugins beschäftigen, wollen wir darüber sprechen, wie man auf diese Plugins innerhalb der Docsie-Plattform zugreift.
Zunächst müssen wir im Arbeitsbereich auf die drei Punkte in der oberen rechten Ecke klicken und unser Konto öffnen:
Dann können wir innerhalb der Einsätze auf die Plugins zugreifen, sobald wir einen neuen Einsatz über "Configure a new deployment+" erstellen
Klicken Sie dann auf "Weitere Optionen", um diese Plugins über ein eingebettetes Skript oder über das Docsie-Portal in Ihre bereitgestellte Dokumentation aufzunehmen
Die andere Möglichkeit ist der Zugriff auf die Wissensportal-Plugins von Docsie über die Schaltfläche "Update deployment configuration" unterhalb Ihrer bereits veröffentlichten Dokumentation.
Das Dashboard wird geöffnet und Sie können nach Belieben Plugins hinzufügen oder entfernen und dann die Bereitstellung aktualisieren.
TEIL 1:
Nun, da wir wissen, wie man auf das Docsie Pluggin zugreift, können wir mit PART 1 beginnen.
Um Teil 1Video-Tutorial zu sehen, schauen Sie sich bitte dieses Video hier an:
Beginnen wir mit dem 'Display version Picker' und dem 'Display Language Picker'.
Sobald diese beiden Funktionen aktiviert sind, werden sie unten links in Ihrem Wissensportal als schwebende Registerkarten angezeigt. Sie ermöglichen es Ihren Kunden und denjenigen, die Ihre Produktdokumentation lesen, Ihre Produktdokumentation in verschiedenen Sprachen und Versionen anzuzeigen.
Sobald der Benutzer auf die Sprache in der Sprachauswahl drückt, wird die gesamte Dokumentation, die er liest, in die zugewiesene Sprache umgewandelt.
Wenn der Anker "Abschnitt anzeigen" aktiviert ist, kann Ihr Kunde neben jeder Überschrift Links einfügen, die ihn zu bestimmten Abschnitten der Dokumentation führen.
Jedes Mal, wenn diese Links angeklickt werden, ändert sich ein Teil der Kopfzeile, und wenn Ihr Kunde diese HTML-Datei kopiert und einfügt, leitet sie die Person, an die sie gesendet wird, zu diesem speziellen Abschnitt der Dokumentation.
Der nächste Schritt ist 'Display Footer Navigation'.
Dieses Plugin fügt eine Navigationsschaltfläche unten rechts in Ihrem Dokumentationsbuch ein. Sie sieht in etwa so aus.
Auf diese Weise können Ihre Kunden bequemer durch Ihre Dokumentation navigieren.
TEIL 2:
Um Teil 2 Video-Tutorial zu sehen, schauen Sie sich bitte dieses Video hier an:
In diesem Teil werden wir das 'Code Highlighting', 'Search' und das 'Share to Social Network' Plugin zeigen
Beginnen wir mit dem 'Code Highlighting'-Plugin
Dieses Plugin ist ideal für technische Produkte, die verschiedene Codes an ihre Kunden weitergeben müssen. Dieses Plugin ermöglicht es den Kunden, den zugewiesenen Code zu kopieren und einzufügen, so dass sie ihn in ihrem Editor verwenden können, indem sie eine Schaltfläche "Kopieren" hinzufügen.
Lassen Sie uns nun in das Such-Plugin eintauchen.
Sobald das Wissensportal Ihres Docsie's aktiviert ist, können Ihre Kunden Ihre Dokumentation über eine Suchnavigation in der oberen rechten Ecke des Wissensportals durchsuchen.
Wenn sie auf "Suchen" klicken, wird ein ausgeklügeltes Dashboard angezeigt, mit dem Ihre Kunden genau feststellen können, wo sie bestimmte Informationen in Ihrem Regal und Ihren Büchern finden.
Dies beschleunigt den Prozess, in dem Ihre Kunden die von ihnen benötigten Informationen über Ihre Produkte finden und abrufen können, erheblich.
Das nächste ist das Plugin Share To Social Networks
Dieses Plugin ermöglicht es Ihren Kunden, hervorgehobene Abschnitte Ihrer schriftlichen Produktdokumentation zu übernehmen und in ihren sozialen Medien zu teilen.
Das ist großartig, weil es den Verkehr, neue potenzielle Kunden und das Vertrauen in Ihre Marke insgesamt erhöhen kann.
PART 3:
Um Teil 3 Video-Tutorial zu sehen, schauen Sie sich bitte dieses Video hier an:
Im dritten Teil werden wir die "Bildvorschau", die "Dokument-Metadaten" und das Plugin "Abschnitt automatisch hervorheben" vorstellen.
Beginnen wir mit dem Bildvorschau-Plugin
Die Bildvorschau ermöglicht es Ihren Kunden, ein Bild Ihrer Produktdokumentation zu vergrößern oder zu verkleinern, um es besser betrachten zu können.
Der nächste Punkt ist 'Metadaten der Dokumentation'.
Dies ermöglicht unseren Kunden, einen Zeitstempel zu sehen, wenn die Produktdokumentation oder Aspekte des Wissensportals aktualisiert worden sind. Er befindet sich am Anfang und am Ende der schriftlichen Dokumentation.
Schauen wir uns nun das 'Auto-Highlight Section Plugin' an
Mit diesem einfachen Plugin können Ihre Kunden verfolgen, wo sie sich in einer bestimmten Dokumentation innerhalb des Wissensportals befinden.
Dadurch wird jeder Standort, an dem sie sich befinden, innerhalb des Wissensportals hervorgehoben, so dass yo8ru-Kunden besser verfolgen können, in welchem Bereich sie sich befinden, und leichter zu anderen Bereichen navigieren können.
All diese Tools und mehr werden Ihnen von Docsie's Plattform zur Verfügung gestellt. Wenn Sie sie noch nicht ausprobiert haben, empfehlen wir Ihnen, dies zu tun. Klicken Sie hier
Wenn Sie Fragen haben, können Sie sich auch gerne an uns wenden: hello@docsie.io