Solange wir Tools und Software nutzen, brauchen wir effektive Kommunikation, um anderen die Nutzung, Entwicklung, Funktionalität und Architektur unserer Produkte zu vermitteln. WARUM? Einfach weil technische Kommunikationsfähigkeiten notwendig sind, um Informationen zu erfassen und dem Publikum zu helfen, das Produkt oder die Technologie besser zu verstehen.
Während Kommunikation in der realen Welt durch Worte oder Ausdrücke stattfindet, erfolgt technische Kommunikation in der virtuellen Welt durch technische Dokumentation!
Technische Produktdokumentation wird mit dem einzigen Ziel erstellt, dem Endnutzer zu helfen, die Funktionsweise und Architektur des verwendeten Produkts oder der Technologie zu verstehen. Es ist eine detaillierte Beschreibung aller Komponenten eines Produkts – eine "Bedienungsanleitung" für neue Mitarbeiter, Nutzer und jeden, der wissen muss, wie es funktioniert.
So einfach es klingt, kann technische Dokumentation verwirrend sein! Die meisten technischen Dokumente umfassen mehrere Phasen, von "Erste Schritte für Anfänger" bis hin zu "Fehlerbehebung bei Bugs oder Fehlern".
Falls du nicht weißt, wo du anfangen sollst, hier ein umfassender Leitfaden, der dir hilft, das Was, Warum und Wie der technischen Dokumentation zu verstehen und den Prozess zu vereinfachen!
Fangen wir an!¶
Du bist an der richtigen Stelle, wenn du neu in der Produktdokumentation bist und noch nie eine Produktdokumentationsspezifikation erstellt hast.
Selbst wenn du die Grundlagen der Erstellung einer Produktdokumentationsspezifikation beherrschst, erfordert die Umsetzung Überlegung und einen strukturierten Ansatz. Hier ist ein Leitfaden zu dem, was du wissen musst und wie du eine flexible und angemessene Produktdokumentationsspezifikation entwickelst.
Wir definieren Produktanforderungen, besprechen ihren Zweck und geben zahlreiche Beispiele für Produktstandards. Du lernst, was in deine Produktdokumentation gehört, wie du sie schreibst – von der Erstellung einer Produktbeschreibung bis zur Anpassung basierend auf Kundenfeedback und begrenzten Nutzertests – und wie du deine Produkte auf den Weg zur Produktion oder in den Softwareentwicklungsprozess bringst.
Was ist der Zweck von Produktdokumentationsspezifikationen?¶
Um eine Produktdokumentationsspezifikation zu erstellen, musst du zunächst ein gutes Verständnis des Produkts haben. Eine Produktdokumentationsspezifikation ist ein Bauplan für die Produktdokumentation, die du entwickelst. Sie beschreibt, wie sie für deine Kunden aussehen wird, sowie die spezifischen Anforderungen und Funktionalitäten deiner Produktdokumentation, wie Suchfunktionen, Sprachänderungsmöglichkeiten und vieles mehr. Zusätzlich kann sie die Persona oder den Verbraucher umfassen, für den das Produkt entwickelt wird – dies gilt hauptsächlich für Produkte, die für bestimmte Altersgruppen gedacht sind.
Diese Produktdokumentationsspezifikation sollte klar, leicht zugänglich sein und alle Informationen enthalten, die dein Design- und Produktteam benötigt. Füge so viele Details wie möglich hinzu, damit dein technisches Redaktionsteam versteht, was zu schreiben ist, und dein Designteam das Layout deiner Produktdokumentation versteht. Eine Tabelle oder ein Diagramm mit schriftlichen Spezifikationen zeigt, wo weitere Informationen zu finden sind. Bedenke jedoch, dass dies nur das Spezifikationsblatt der Produktdokumentation ist – die Details zu spezifischen Aspekten des Produkts kannst du deinem Team für spätere Arbeitsabschnitte überlassen.
Welche Informationen sollte eine Produktdokumentationsspezifikation enthalten?¶
Jede Produktspezifikation basiert auf technischen Anforderungen, Engineering-Spezifikationen und anderen produktspezifischen Informationen. In deiner Produktdokumentation sollten jedoch mindestens folgende Elemente enthalten sein:
Zusammenfassung: Ein Überblick über das Produkt auf hoher Ebene. Er beginnt mit einer Übersicht des Produktkonzepts und endet mit einer präzisen Beschreibung des Produkts und seiner Gesamtdetails. Außerdem wird erklärt, warum das Produkt entwickelt wurde und welchen allgemeinen Zweck es hat. Die Produktbeschreibung beschreibt das Erscheinungsbild des fertigen Produkts und die Funktionen, die es haben wird.
Funktionale Spezifikationen: Eine schriftliche Darstellung, die das Aussehen und die Fähigkeiten deines Produkts definiert. Sie sollte auch beschreiben, wie Menschen damit interagieren werden. Bei diesen Erklärungen ist es wichtig, so detailliert wie möglich zu sein und nichts auszulassen.
Anwendungsfall: Das Produkt sollte den Anwendungsfall jeder Funktion oder jedes Features des Produkts und den Nutzen für den Endbenutzer angeben. Dies könnte als Marketingmaterial angesehen werden. Wenn der Benutzer jedoch ein Handbuch hat, das auch den Anwendungsfall jeder Funktion erklärt, hilft dies zu verstehen, wie es zu verwenden ist.
Benutzer-Personas: Dieser Abschnitt beschreibt die Zielgruppe, für die dieses Produkt entwickelt wurde. Er detailliert die Zieldemografie und die Probleme, die das Produkt lösen wird. Das Wissen über die Zielgruppe des Produkts stellt sicher, dass deine Arbeit kundenzentriert bleibt. Wenn dein Produkt bestimmte Gefahren birgt, die nicht für Kinder geeignet sind, ist es ratsam, dies in deiner Produktdokumentation anzugeben.
Bilder/Videos: Jeder Abschnitt sollte notwendige Bilder oder Videos deiner Produkte in Zusammenhang mit schriftlichen Informationen zur Verwendung des Produkts enthalten. Dies verbessert deine Produktdokumentation und die Anwendungsfälle des Produkts.
Wie man effektive technische Dokumentation plant, schreibt und liefert¶
Technische Dokumentation kann sehr anspruchsvoll und komplex werden! Das Wichtigste ist, dass dein Inhalt aktuell, genau und für dein Publikum interessant bleibt, indem du diese einfachen Schritte befolgst:
Sei klar darüber, was dein Leser nach dem Lesen tun soll:¶
Technische Dokumentation konzentriert sich vollständig auf die nächste Aktion des Lesers. Gib deinen Zweck für jeden Schritt und jede Phase deiner Produktdokumentation an, damit der Benutzer versteht, was er nach dem Lesen erreichen kann. Wenn du über das Endziel des Dokuments Klarheit hast, wird das Schreiben deines Teils einfacher. Je umfassender deine Dokumentation ist, desto leichter wird es für deine Leser, durch die Informationen zu navigieren. Docsie bietet viele Werkzeuge, die dabei helfen, zum Beispiel unsere Suchnavigationsfunktion, mit der deine Benutzer durch deine Dokumentation suchen und Informationen schnell finden können!
Erstelle einen Überblick für die Dokumentation:¶
Ohne einen strukturierten Plan kann es schwierig sein, eine Produktdokumentation zu erstellen, die gut fließt und die Hauptziele deiner Dokumentationskriterien effektiv erreicht. Daher wird dringend empfohlen, mit einem Gerüst zu beginnen, auf dem deine Dokumentation aufbauen kann. Nutze Überschriften, Kategorien, Unterkategorien und Themen, um deine Materialien richtig zu organisieren und zu gruppieren. Docsie bietet viele großartige Tools, mit denen du schnell und effektiv Dokumentation erstellen kannst, und zielt darauf ab, dynamische Produktdokumentationen zu erstellen.
Wir bieten Suchfunktionen, eine gut strukturierte Organisation für deine Dokumentation sowie viele andere leistungsstarke Funktionen.
Definiere deine Zielgruppe:¶
Es ist wichtig zu verstehen, welches Publikum deine Produkte nutzt, um festzustellen, ob deine Dokumentation für Entwickler, Mitarbeiter oder Benutzer bestimmt ist. So stellst du sicher, dass die Nutzer den Kontext, die Ziele und die Fähigkeiten des Produkts oder der Technologie verstehen, und es hilft dir, dich an dein Publikum anzupassen. Wenn deine Zielgruppe aus einem anderen Land als dem deines Hauptsitzes kommt, ist übersetzte Dokumentation ein weiterer Faktor, den du berücksichtigen musst.
Füge Zeichnungen und Beschriftungen in deinen Inhalt ein:¶
Illustrationen oder Diagramme einer technischen Dokumentation müssen verschiedene Maße enthalten, die die Dimensionen oder Aspekte deiner Produkte erklären. Wenn du Funktionen eines digitalen SaaS-Produkts demonstrierst, sind Ausschnitte dieser Funktionen sehr hilfreich, solange du zeigst, was sie tun und wie sie funktionieren.
Bilder helfen außerdem, die Monotonie von Worten zu durchbrechen und Interesse am Dokument zu wecken. Beschriftungen können dazu beitragen, Produktdiagramme und Zeichnungen mit klaren Anweisungen in Perspektive zu setzen.
Erneut lesen, bearbeiten und umschreiben:¶
Gehe deine technische Dokumentation mehrmals durch, um sicherzustellen, dass du nichts übersehen hast! Du kannst deine Arbeit auch von einem Kollegen oder Vorgesetzten redigieren lassen, um zu überprüfen, ob du nichts vergessen hast. Ein Überprüfungs- und Änderungsmechanismus würde sicherstellen, dass der veröffentlichte Inhalt korrekt ist.
Docsie bietet tolle Tools, die dir bei der Erstellung deiner Produktdokumentation helfen können. Wenn du mehr über Docsie erfahren möchtest, klicke hier.