Erstellung technischer Dokumentationen (Schritt-für-Schritt-Anleitung)

Was ist technische Dokumentation?

Technische Dokumentation ist eine Art von schriftlichem Material, das detaillierte Informationen darüber enthält, wie ein Produkt, eine Dienstleistung oder ein System verwendet, erstellt, gewartet und Fehler behoben werden können.

Zum Beispiel bezieht sich technische Dokumentation in der Softwareentwicklung auf einen Oberbegriff, der sich auf alle Anleitungen und anderen Inhalte bezieht, die mit der Entwicklung und den Funktionen bestimmter Produkte zusammenhängen.

Hier ist der Hauptunterschied zwischen normaler (oder allgemeiner) Dokumentation und technischer Dokumentation:

Normale Dokumentation	Technische Dokumentation
Bietet allgemeine Informationen in einfacherer Sprache.	Bietet tiefgehende Informationen, oft einschließlich technischer Begriffe, Code-Schnipsel, Diagramme und Beispiele.
Wird normalerweise erstellt, um einen schnellen Überblick über ein Produkt oder eine Dienstleistung in Form von Benutzerhandbüchern oder FAQs zu geben.	Enthält Anleitungen zur Verwendung, Erstellung, Wartung und Fehlerbehebung eines Produkts oder Systems. Einige Beispiele sind API-Dokumentation, Architekturhandbücher oder Systemdesign-Dokumente.
Entwickelt für Endbenutzer, Kunden oder Personen mit begrenzten technischen Kenntnissen.	Entwickelt für Entwickler, Ingenieure oder IT-Profis.

Und es gibt noch viel mehr über technische Dokumentation, das wir in dieser Anleitung aufdecken werden.

Warum ist technische Dokumentation wichtig?

Technische Dokumentation ist ein Asset, das verschiedenen Stakeholdern dient, indem es ihnen hilft, das Produkt und seine Entwicklung zu verstehen und auf dem gleichen Stand zu sein.

Und bietet gleichzeitig Kunden und Klienten eine Möglichkeit, Probleme mit einem Self-Help-Kanal zu lösen.

Technische Dokumentation ist entscheidend geworden, um erstklassigen Kundenservice zu bieten und gleichzeitig die Kosteneffizienz aufrechtzuerhalten.

Eine Studie von ThinkHDI¹ zeigt, dass Self-Service-Kanäle durchschnittlich nur 2,37 US-Dollar kosten, während persönliche Kanäle durchschnittlich 15-37 US-Dollar kosten.

Hier sind einige weitere Vorteile technischer Dokumentation:

1. Verbessert die Kommunikation und Zusammenarbeit abteilungsübergreifend, indem sie als einzige Informationsquelle dient.
2. Steigert Effizienz und Produktivität
3. Verbessert die Kundenzufriedenheit durch Self-Service-Kanäle und schnelle Antworten.
4. Senkt die Kosten für den Kundenservice durch Reduzierung der Anzahl von Support-Tickets.
5. Verkürzt die Einarbeitungszeit und hilft neuen Mitarbeitern, schnell einsatzbereit zu sein.
6. Ermöglicht schnelle Entscheidungsfindung
7. Bietet eine Roadmap für zukünftige Projekte
8. Ideen aufzeichnen
9. Fördert die Wissensspeicherung

Arten der technischen Dokumentation

Technische Dokumentation kann in zwei Haupttypen unterteilt werden::

1. Produktdokumentation umfasst System- und Benutzerdokumentation.
2. Prozessdokumentation umfasst Prozess-Benchmarks und interne Abläufe

1. Produktdokumentation

Produktdokumentation enthält Informationen über das im Bau befindliche Produkt und gibt Anleitungen zu seinen Anwendungsfällen.

Diese Informationen umfassen Produktanforderungen, Geschäftslogik, technische Spezifikationen und Benutzerhandbücher.

Systemdokumentation

Systemdokumentation bietet einen Überblick über das Framework zur Produktentwicklung und ermöglicht es Produktentwicklern und anderen Beteiligten, die zugrunde liegende Technologie zu verstehen.

Typischerweise umfasst sie die Anforderungen, Spezifikationen, den Quellcode, das Architekturdesign, Validierungsberichte, Authentifizierungs- und Testdetails sowie Wartungsanweisungen.

Benutzerdokumentation

Benutzerdokumentation wird für diejenigen erstellt, die das Produkt verwenden. Die Arten von Benutzern können jedoch variieren. Deshalb müssen Sie diese Dokumente basierend auf verschiedenen Nutzungskategorien und Kenntnisständen erstellen.

Normalerweise richtet sich die Benutzerdokumentation an zwei Hauptsegmente: Systemadministratoren und Endbenutzer.

Diese Art von Dokumentation umfasst Anleitungen, Benutzerhandbücher, Installationsanleitungen, Fehlerbehebungsdokumente, Bedienungsanleitungen, häufig gestellte Fragen und Hilfeführer.

2. Prozessdokumentation

Prozessdokumentation umfasst jedes Inhaltselement, das im Hinblick auf die Erstellung und Verwaltung von Prozessen im Zusammenhang mit der Produktentwicklung erstellt wird.

Der Hauptunterschied zwischen Prozess- und Produktdokumentation besteht darin, dass erstere die technischen Verfahren dokumentiert, während letztere das Produkt erklärt.

Der Grund für die Pflege der Prozessdokumentation ist die Verbesserung der Organisation und Planung der technischen Phase.

Diese Art von Dokumentation erfordert Vorbereitung und Strategie vor Beginn des Prozesses und auch während der Erstellung des Produkts.

Typische Prozessdokumentation umfasst Standardarbeitsanweisungen, Projektdokumentation, Prozess-Blaupausen, Testtermine, White Papers, Besprechungsprotokolle und auch Unternehmenskommunikation.

Beispiele für technische Dokumentation

Hier sind einige Beispiele für gute technische Dokumentation und was man daraus lernen kann.

1. Spren Dokumentation

Spren ist ein Unternehmen, das APIs für die Verbindung mit gesundheitsbezogenen mobilen Apps anbietet, um maßgeschneiderte und präzise biometrische Informationen bereitzustellen.

Aber das ist ein kniffliger Prozess und erfordert technisch Artikel, die einfach zu verstehen und von einem Profi erstellt sind. So können die App-Unternehmen die Lösung nahtlos in ihre jeweiligen Projektzyklen integrieren.

Deshalb ist Sprens Dokumentation ein großartiges Beispiel für richtig gemachte technische Dokumentation. Sie bietet eine Fülle von visuellen Elementen und Illustrationen, um Kunden zu fesseln und die Dokumentation leichter verständlich zu machen.

2. Spryker Dokumentation

Die Dokumentation von Spryker muss verschiedene Benutzergruppen ansprechen, darunter Programmierer und Techniker, die für die Installation und Wartung der Software verantwortlich sind. Und auch der Zielkunde, der Spryker zur Betreibung seines Online-Shops nutzen wird.

Das bedeutet, dass ihre Dokumentation Inhalte haben sollte, die unterschiedliche Bedürfnisse erfüllen. Außerdem sollten sie sie entsprechend der technischen Kompetenz des Zielendbenutzers entwickeln.

Und genau das haben sie getan. Sie haben die Dokumentation nach Benutzergruppen geordnet.

Wie sichtbar, muss jede Person, die die Dokumentation nutzt, zuerst ihre Kategorie aus den drei Zielgruppentypen (Geschäftsanwender, Entwickler, Cloud-Ingenieure) bestimmen und dann eine Sammlung von Anleitungen auswählen.

Sobald der Benutzer den entsprechenden Bereich betritt, sieht er Anleitungen, die für seine Rolle und seinen technischen Kenntnisstand konzipiert sind.

Wie Sie im obigen Beispiel für technische Dokumentation sehen können, ist das Hauptziel sicherzustellen, dass Programmierer und andere Benutzer die gesuchten Anleitungen leicht finden können.

3. Metric Insights Hilfe & Dokumentation

Metric Insights ist ein Push-Intelligence-System, das Ihre Besucherinteraktionsinformationen und andere Details nutzt, um Ihnen praktische Ideen zur Verbesserung Ihrer Website zu liefern.

Mit ihrer technischen Benutzerdokumentation sehen Sie, wie sie mehrere Szenarien abgedeckt haben.

Aus der Perspektive eines normalen Benutzers bei der Verwendung eines Produkts bis hin zur Perspektive eines Administrators.

Anleitungen zur Fehlerbehebung, Wartung und Versionshinweise. Außerdem sind die Anleitungen sehr detailliert und visuell ansprechend.

So erstellen Sie technische Dokumentationen

Schritt 1: Anforderungen und Art des zu erstellenden Inhalts festlegen

Denken Sie bei der Planung technischer Dokumentationen darüber nach, warum sie für Ihr Unternehmen nützlich sein kann, wie viel Dokumentation benötigt wird und ob es sich lohnt, Zeit und Geld in die Erstellung zu investieren?

Zu wenig technische Dokumentation kann die allgemeine Nützlichkeit beeinträchtigen. Andererseits verwirrt zu viel Information die Dinge für Sie.

Hier sind die Arten von Inhalten, die Sie mit Ihrer technischen Dokumentation planen können:

• Produktumfang und Planung
• Systemdokumentation
• Quellcode, API-Dokumentation
• Fehlerbehebungs- und Wartungshandbücher
• Changelogs
• Anwendungsfälle
• Benutzerhandbücher
• Prozessdokumentation

Schritt 2: Technische Dokumentation schreiben

Die Nützlichkeit Ihrer technischen Dokumentation hängt von der Schreib- und Lehrqualität der Anleitungen ab, insbesondere wenn Sie sie zur Lösung von Kundenproblemen erstellen.

Hier sind einige Tipps zum Schreiben hochwertiger technischer Dokumente:

2.1. Schreiben Sie für Ihr Publikum

Das Verständnis des Publikums ist sehr wichtig. Zum Beispiel würde das Servieren von nicht-vegetarischem Essen für Vegetarier nicht funktionieren – oder?

Dasselbe gilt für jede Art von Dokumentation.

Sie müssen Ihre Lehrmethoden anpassen, je nachdem, für wen Sie schreiben.

Schauen wir uns das WordPress-Beispiel an:

Beispiel für kundenorientierte WordPress-Dokumentation.

Beispiel für technische WordPress-Dokumentation.

Der Unterschied hier?

Zielgruppe: Normale Dokumentation wird für Redakteure, Blogger, Manager oder Personen ohne technisches Wissen erstellt.

Während technische Dokumentation für Entwickler, Ingenieure, Serverbetreiber oder technische Benutzer erstellt wird.

Inhaltlicher Unterschied: Normale Dokumentation ist sehr einfach, direkt auf den Punkt gebracht und enthält keine technischen Details.

Während technische Dokumentation viele Informationen, verlinkte Ressourcen, Code und reale Beispiele dafür enthält, wie jemand bestimmte Funktionen oder Parameter verwenden kann.

Erforderliche Erfahrung: Die normale Dokumentation kann von jedem mit Schreibfähigkeiten und etwas Produktrecherche erstellt werden, während technische Dokumentation die Beteiligung eines Entwicklers oder Experten erfordert, um korrekt und nützlich zu sein.

2.2. Produkt, Code oder Forschung gründlich testen

Dokumentation wird erstellt, um Kunden zu helfen oder um ein besseres Verständnis der Situation zu erlangen.

Normalerweise wird kundenorientierte Dokumentation von einem Dokumentationsautor, Kundendienstmitarbeitern oder einem Autor erstellt. Und es funktioniert.

Aber bei der technischen Dokumentation ist das nicht dasselbe. Sie benötigen mehr als nur Produkt- oder Codeverständnis.

Einblicke, die nur durch richtige Beteiligung und Tests gewonnen werden können.

2.3. Mit einer Gliederung beginnen

Das Erstellen einer Gliederung vor jedem Leitfaden oder Tutorial dauert nicht lange (normalerweise 1 Stunde), kann aber in späteren Phasen der Inhaltserstellung viel Zeit sparen.

Haben Sie sich jemals gefragt, warum Ihre Artikel/Anleitungen nicht gut klingen, funktionieren oder diese professionelle Ausstrahlung haben?

Weil sie nicht gut geplant waren.

Hier sind einige Dinge, die Sie mit den Gliederungen Ihrer technischen Dokumente abdecken können:

1. Titel
2. Ziel-Keywords oder die gebräuchlichsten Suchbegriffe
3. User Stories (Als Benutzer möchte ich, damit-Formel)
4. Zielgruppe, für wen es ist
5. Artikeltyp: How-to, Listicles, Video, Rezension oder Vergleich zum Beispiel.
6. Ziele
7. Referenzartikel
8. Erwartete Wortanzahl
9. Kurze Gliederung (oder Inhaltsverzeichnis): Umfang dessen, was Sie abdecken werden, vorhandene Ressourcen und Artikelstruktur.

2.4. Halten Sie es einfach (verwenden Sie Vorlagen) und fügen Sie keinen unnötigen Ballast hinzu

Das Hinzufügen von nur notwendigen Informationen sollte einer der Hauptpunkte in Ihrem Schreibstil-Leitfaden für technische Dokumentation sein.

Außerdem können Sie basierend auf Ihrer Erfahrung und Ihren Tests Vorlagen (Artikeltyp-Vorlagen) erstellen, die für die Art der von Ihnen erstellten Inhalte am besten geeignet sind.

1. Vermeiden Sie die Verwendung von Fachbegriffen und erklären Sie diese, wenn Sie sie absolut nicht vermeiden können.
2. Halten Sie Absätze kurz.
3. Gliedern Sie Inhalte mit Überschriften, Unterüberschriften, Listen, Tabellen und Bildern auf.
4. Vermeiden Sie übermäßige Erklärungen und entfernen Sie so viel wie möglich unnötige Inhalte.

2.5. Visuelle Hilfsmittel verwenden

Visuelle Elemente machen einen Unterschied, insbesondere wenn sie technische Konzepte leicht verständlich machen.

Es kann ein einfacher Screenshot, eine Skizze, eine Zeichnung oder eine gut gestaltete Grafik sein. Solange es hilft!

2.6. Beispiele und Referenzen hinzufügen, wann immer möglich

Technische Dokumentation befasst sich mit der Dokumentation und Aufschlüsselung komplexer Informationen.

Das Hinzufügen von Beispielen und das Verlinken relevanter Ressourcen, wann immer möglich, hilft dabei.

Sie können Beispiele hinzufügen, um Folgendes zu zeigen:

• Code-Verwendung (wie eine bestimmte Funktion oder ein Parameter verwendet werden kann)
• Produkt- oder Softwareanwendungsfälle. Insbesondere wenn es mehrere Möglichkeiten gibt.
• Wie eine bestimmte Sache oder Funktion implementiert wurde oder wie ein Wettbewerber es gemacht hat.

2.7. Überprüfen lassen

Beziehen Sie Entwickler, Ingenieure und Teammitglieder in den Dokumentationsprozess ein, um ein besseres Verständnis der Lösung zu erhalten.

Das Erstellen technischer Artikel erfordert die kollektive Beteiligung aller Gruppenmitglieder.

Sobald Sie einige technische Beiträge vorbereitet haben, zeigen Sie sie Ihren Kollegen und holen Sie deren Meinungen ein.

Um die Dinge zu vereinfachen, verwenden Sie Kollaborationssoftware wie Kanban-Boards, Slack und Google Docs.

2.8. Erstellen Sie einen Styleguide für technische Texte

Wenn Sie mit der Erstellung Ihrer technischen Inhalte beginnen, erstellen Sie einen Styleguide, der für Sie am besten funktioniert.

Er hilft, Wissen zu bewahren, Konsistenz zu schaffen und die Qualität der Inhalte aufrechtzuerhalten.

Zum Beispiel kann Ihr Styleguide Folgendes enthalten:

1. Zielgruppenprofil oder Zielgruppe
2. Schreibstil und Ton
3. Grammatik- und Nutzungsregeln
4. Formatierungsrichtlinien Terminologie
5. Dokumentenstruktur
6. Visuelle Richtlinien
7. Barrierefreiheitsstandards
8. Richtlinien für Links und externe Verweise
9. Überprüfungs- und Genehmigungsprozess
10. Werkzeuge und Ressourcen

Wir haben in unserem Knowledge Base Style Guide viel über Styleguides gesprochen, der Ihnen einen guten Ausgangspunkt bietet.

Schritt 3: Erstellung einer technischen Dokumentationswebsite

🤯, ich weiß, ich weiß.

Wenn Sie dem Leitfaden bisher gefolgt sind, ist das viel zu verarbeiten. Aber ich empfehle dringend, etwas Zeit zu investieren, um Ihre Inhalte zusammenzustellen.

Denn das wird Ihre technische Dokumentation für Sie und Ihre Benutzer normal machen, nicht technisch.

Denken Sie daran, dass Sie nicht von Anfang an das Beste anstreben müssen, da Erfahrung, Tests und Feedback viel dazu beitragen, etwas Nützliches zu schaffen.

Ständige Verbesserung ist hier der Schlüssel. Jetzt benötigen wir eine Website oder eine Plattform, um erstellte Inhalte zu veröffentlichen.

3.1. WordPress-Website erstellen

Wir erstellen eine dedizierte technische Dokumentationswebsite oder ein Portal, auf dem Sie alle Ihre privaten und öffentlichen Dokumente hosten und pflegen können.

Warum eine Website für Dokumentation erstellen?

1. Benutzerdefiniertes Branding
2. Bessere Benutzererfahrung
3. Zentralisierter Zugriff
4. Erweiterte Funktionen wie Integration, Analysen, Versionskontrolle und -verwaltung.
5. Vollständige Kontrolle

Ich empfehle dringend WordPress mit Heroic Knowledge Base (Heroic KB) für die Dokumentationswebsite, und das werden wir für dieses Tutorial verwenden.

WordPress ist kostenlos, Open Source und die beliebteste CMS-Plattform für Dokumentationen.

Während Heroic KB ein Premium-WordPress-Plugin ist, um jede Art von Dokumentationswebsite zu erstellen.

Wenn Sie eine kostenlose Lösung wünschen und über ein Entwicklungsbudget oder -fähigkeiten verfügen, können Sie Lösungen wie MkDocs verwenden.

Um eine WordPress-Website zu erstellen, können Sie sie auf jeder Art von Hosting-Service installieren (einschließlich Webhosting, Cloud-Hosting und dedizierten Servern).

Um es einfach zu halten, verwenden Sie verwaltete WordPress-Hosting-Plattformen wie Kinsta.

Überprüfen Sie außerdem diese Anleitung, wenn Sie planen, WordPress manuell zu installieren, oder bitten Sie einfach Ihren Hosting-Anbieter, WordPress für Sie zu installieren.

3.2. Dokumentations-Website erstellen

Jetzt, da Sie eine WordPress-Site eingerichtet haben, installieren Sie das Heroic KB-Plugin, um die für Ihr Dokumentationsportal benötigten Funktionen zu erhalten.

Laden Sie das Heroic KB-Plugin herunter, indem Sie es hier kaufen.

1. Gehen Sie zum WordPress Dashboard (das Sie erreichen, indem Sie /wp-admin am Ende Ihrer Website-URL hinzufügen)
2. Klicken oder fahren Sie mit der Maus über Plugins → Neues Plugin hinzufügen.
3. Klicken Sie auf die Schaltfläche Plugin hochladen.
4. Wählen Sie eine heruntergeladene Heroic KB-Plugin-Datei.
5. Klicken Sie auf die Schaltfläche Jetzt installieren.
6. Klicken Sie nach der Installation auf Plugin aktivieren.

Sobald das Plugin aktiviert ist, wird Ihnen ein Heroic Knowledge Base Setup-Assistent angezeigt.

Folgen Sie den Anweisungen, um die Demo-Website zu importieren, wie hier gezeigt: https://heroickb.herothemes.com/

Hinweis: Sie können den Setup-Assistenten über den Plugin-Bereich aufrufen, wenn Sie ihn während des Installationsvorgangs nicht abgeschlossen haben.

Ihre Dokumentationswebsite ist zu diesem Zeitpunkt fertig und Sie können sie im Frontend unter ihredomain.com/knowledge-base/ aufrufen.

3.3. Benutzerzugriff und Rollen

Mit WordPress und Heroic KB haben Sie alle notwendigen Optionen, um Benutzerzugriff und Rollen zu verwalten. So können Sie interne oder öffentlich zugängliche Dokumentationen erstellen.

Benutzer können über WordPress → Benutzer verwaltet werden. Sie können neue Benutzer manuell hinzufügen oder eine WordPress-Option aktivieren, um die Registrierung neuer Benutzer zu ermöglichen.

Aktualisieren Sie die Heroic KB-Einstellungen, um die Dokumentation nur für den internen Gebrauch zu machen, oder Sie haben die Option, jeden Artikel als intern oder öffentlich zu kennzeichnen.

WordPress → Heroic KB → Einstellungen

3.4. Anpassung

Mit technischer Dokumentationssoftware wie Heroic KB haben Sie alle Optionen, die Sie benötigen, um die Dokumentation an Ihren Markenstil oder Ihre Vorlieben anzupassen.

Alle Einstellungen können unter WordPress → Heroic KB → Einstellungen aufgerufen werden.

Zum Beispiel, um das Farbschema der Dokumentation zu aktualisieren:

Zum Aktualisieren der Layout-Einstellungen:

Weitere Anpassungen können mit WordPress-Themes oder benutzerdefiniertem Code vorgenommen werden.

Mit einem Heroic KB-Kauf erhalten Sie ein Premium-Theme Heroic KnowAll, das unbegrenzte Anpassungsmöglichkeiten ohne eine einzige Zeile Code freischaltet.

Schritt 4: Veröffentlichung und Verwaltung von Dokumenten

Jetzt, da wir Inhalte und ein Portal bereit haben, müssen Sie nur noch Ihre Inhalte hinzufügen und veröffentlichen.

Sie können alle Ihre Artikel, Kategorien und Schlagwörter unter WordPress → Heroic KB verwalten.

Um einen neuen Artikel hinzuzufügen, klicken oder fahren Sie mit der Maus über Heroic KB → Neuen Artikel hinzufügen.

Und so sieht Ihr Artikel-Builder-Bildschirm aus:

Es ist ein sehr einfach zu bedienender und flexibler Editor, sobald Sie sich daran gewöhnt haben.

Außerdem erhalten Sie zusätzliche Blöcke von Heroic KB, um einfach ein Inhaltsverzeichnis, Toggles, Akkordeons, Tabs, Codeblöcke zu erstellen oder wichtige Informationen zu teilen.

Das gesamte Styling kann über WordPress-Themes oder über kundenspezifischen Code verwaltet werden.

Schritt 5: Weiter optimieren

Die Erstellung technischer Dokumentationen endet nicht mit der Veröffentlichung von Inhalten.

Es ist ein kontinuierlicher Verbesserungsprozess, bei dem Dokumentationen genutzt werden, um das Wissen Ihres Unternehmens aufzubauen, die Neuerfindung des Rades zu vermeiden und Prozesse zu optimieren.

Hier sind einige Tipps, wie Sie Ihre technische Dokumentation optimieren können:

1. Optimieren Sie die Erstellung und Verwaltung von Inhalten
2. Erstellen und verbessern Sie Richtlinien für technische Dokumentationen basierend auf Benutzerfeedback
3. Stellen Sie eine einfache Navigation und einen einfachen Zugriff auf die Dokumentation sicher
4. SEO-Optimierung
5. Führen Sie häufige Backups durch

Heroic KB und WordPress verfügen über integrierte Funktionen zur Verbesserung der Dokumentation.

Funktionen wie leistungsstarke Analysen, Feedbacksystem, SEO-freundliche Website-Struktur und Integrationen, redaktionelle Optionen und Revisionskontrolle.

Tools und Software für technische Dokumentation zur Unterstützung

Ich werde hier kurz sein, da wir bereits sehr detaillierte Anleitungen zu Tools für technische Dokumentation und Tools für technische Texte haben.

Diese empfohlenen Tools werden Ihnen bei der Erstellung, Verwaltung und Optimierung technischer Dokumentationen erheblich helfen.

WordPress + Heroic KB: Heroic KB ist ein beliebtes, preisgünstiges und kollaboratives System für technische Dokumentation. Es eignet sich für eine Vielzahl von Branchen und Produkten.

Dies erfüllt problemlos die meisten Anforderungen an Ihre technische Dokumentation.

Mammoth .docx converter: Ein WordPress-Plugin, mit dem Sie Dokumente einfach importieren können, um Beiträge und Seiten zu erstellen.

Vervollständigen Sie Ihren Artikel mit Google Docs und veröffentlichen Sie ihn mit WordPress in nur unter 5 Minuten mit diesem Tool. So einfach ist es, Inhalte mit WordPress zu veröffentlichen.

Github: Wahrscheinlich kennen Sie dieses bereits. Sie können es auch für technische Dokumentationen nutzen. Es verfügt über eine eigene Wiki-Plattform, die für 5-20 Dokumentationsstücke gut geeignet ist.

Figma: Es ist eine webbasierte Designsoftware, die einfach zu bedienen und sehr flexibel ist.

Ähnlich wie WordPress verfügt es über unzählige Plugins zur Erweiterung seiner Funktionalität, Vorlagen zur schnellen grafischen Erstellung und Kollaborationsfunktionen. Es ist eines der besten kostenlosen Tools, die es gibt. Probieren Sie es aus!

Google Docs: Sie benötigen eine einfache Möglichkeit, Inhalte zu erstellen und gleichzeitig mit dem Team zusammenzuarbeiten, und Google Docs ist dafür am besten geeignet.

FastStone Capture: Ein Premium-Tool zum Erfassen und Aufzeichnen von Bildschirmen. Sie können Anmerkungen zu Bildern hinzufügen und diese mit anderen erstaunlichen Funktionen bearbeiten. Es wird mit einer lebenslangen Lizenz geliefert, die sich absolut lohnt!

MkDocs: Eine großartige Plattform, um kostenlos statische technische Dokumentationswebsites zu erstellen. Es verfügt über viele gute Themes und Plugins zur Verbesserung des Gesamterscheinungsbilds und der Funktionalität, erfordert jedoch Entwicklungsfähigkeiten.

Häufig gestellte Fragen zur technischen Dokumentation

Hier sind unsere am häufigsten gestellten Fragen zur technischen Dokumentation, zusammen mit ihren Antworten.

Was ist der Zweck der technischen Dokumentation?

Der Zweck der technischen Dokumentation besteht darin, Informationen über ein Produkt, ein System oder eine Dienstleistung bereitzustellen, die von einem technischen oder nicht-technischen Publikum verwendet werden. Diese Dokumentation hilft Benutzern zu verstehen, wie das Produkt funktioniert, wie es installiert, verwendet und Fehler behoben werden können und wie Teile bei Bedarf repariert oder ersetzt werden können.

Technische Dokumentation dient auch als Referenz für Ingenieure, Entwickler und andere Fachleute, die an dem Produkt arbeiten. Sie trägt dazu bei, Konsistenz und Standardisierung zu gewährleisten und einen historischen Überblick über die Entwicklung und Evolution des Produkts zu geben.

Wie organisiert und strukturiert man technische Dokumentation?

Hier sind einige Best Practices für die Organisation und Strukturierung technischer Dokumentation:

• Beginnen Sie mit einem Inhaltsverzeichnis oder einem Index, um einen Überblick über die behandelten Themen zu geben.
• Teilen Sie die Dokumentation in klare Abschnitte ein und verwenden Sie Überschriften und Unterüberschriften, um den Leser zu leiten.
• Verwenden Sie eine klare, prägnante Sprache und vermeiden Sie Fachjargon, es sei denn, er ist unvermeidlich und wird gründlich erklärt.
• Fügen Sie Beispiele und visuelle Hilfsmittel wie Diagramme und Screenshots hinzu, um komplexe Konzepte zu veranschaulichen.
• Verwenden Sie durchgängig ein konsistentes Format und einen konsistenten Stil für die Dokumentation, einschließlich Schriftgröße und -stil, Überschriften und Absatzabständen.
• Stellen Sie eine Suchfunktion oder einen Index für eine einfache Navigation bereit, insbesondere bei umfangreichen Dokumentationen.

Was ist der Unterschied zwischen technischer Dokumentation und Benutzerdokumentation?

Technische Dokumentation und Benutzerdokumentation sind beides Formen schriftlicher Dokumentation, die Informationen über ein Produkt oder eine Dienstleistung liefern. Sie haben jedoch unterschiedliche Zwecke und Zielgruppen.

Technische Dokumentation richtet sich an technische Benutzer wie Ingenieure, Entwickler und IT-Profis. Sie liefert detaillierte Informationen über das Design, die Architektur und die technischen Spezifikationen des Produkts und wird zur Fehlerbehebung und Wartung verwendet.

Benutzerdokumentation hingegen richtet sich an Endbenutzer wie Kunden und Mitarbeiter, die das Produkt oder die Dienstleistung nutzen. Sie liefert Informationen zur Verwendung des Produkts, einschließlich Schritt-für-Schritt-Anleitungen und visueller Hilfsmittel.

Zusammenfassung

Technisches Wissen ist ein wesentlicher Vermögenswert für Leser. Sie müssen nützliche technische Artikel für alle entwickeln und veröffentlichen, einschließlich Dokumente für Softwareentwickler und das Testteam sowie Benutzerdokumentation.

Doch aufgrund der schnellen Produktentwicklungszyklen kann es schwierig sein, Ihre technische Dokumentation verfügbar und ansprechend zu gestalten.

Ein umfassendes technisches Wissensportal ist präzise, auf den Punkt gebracht und relevant. Und hier kann ein System zur Verwaltung technischer Dokumentationen wie Heroic KB helfen.

Mit den Content-Management- und Teamwork-Funktionen von Heroic KB können Sie Ihren Autorenpflegeprozess und Ihre technischen Anleitungen einfach verbessern. Und steigern Sie die Produktivität und das Benutzerengagement Ihrer Organisation.

In diesem Tutorial erwähnte Ressourcen

1. Verständnis der Service-Desk-Metrik Kosten pro Ticket von ThinkHDI ↩︎