Wie man technische Dokumentation erstellt (Schritt-für-Schritt-Anleitung)

Was ist eine technische Dokumentation?

Technische Dokumentation ist eine Art von schriftlichem Material, das detaillierte Informationen über die Verwendung, Erstellung, Wartung und Fehlerbehebung eines Produkts, einer Dienstleistung oder eines Systems enthält.

In der Softwareentwicklung beispielsweise ist technische Dokumentation ein übergeordneter Begriff, der sich auf alle Anleitungen und sonstigen Inhalte im Zusammenhang mit der Entwicklung und den Funktionen bestimmter Produkte bezieht.

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

Normale Dokumentation	Technische Dokumentation
Bietet allgemeine Informationen in einfacher Sprache.	Bietet ausführliche Informationen, oft mit Fachbegriffen, Codeschnipseln, Diagrammen und Beispielen.
Normalerweise werden sie erstellt, um einen schnellen Überblick über ein Produkt oder eine Dienstleistung in Form von Benutzerhandbüchern oder FAQs zu geben.	Enthält Anweisungen zur Verwendung, Erstellung, Wartung und Fehlerbehebung eines Produkts oder Systems. Einige Beispiele sind API-Dokumentation, Architekturhandbücher oder Systementwurfsdokumente.
Entwickelt für Endbenutzer, Kunden oder Personen mit begrenzten technischen Kenntnissen.	Entwickelt für Entwickler, Ingenieure und IT-Fachleute.

Und es gibt noch so viel mehr in der technischen Dokumentation, das wir in diesem Leitfaden aufdecken werden.

Warum ist technische Dokumentation wichtig?

Technische Dokumentation ist ein Aktivposten, der verschiedenen Interessengruppen dient indem sie ihnen hilft, das Produkt und seine Entwicklung zu verstehen und auf derselben Seite zu stehen.

Gleichzeitig können Kunden und Klienten Probleme über einen Selbsthilfekanal lösen.

Die technische Dokumentation ist für die Bereitstellung eines erstklassigen Kundendienstes bei gleichzeitiger Kosteneffizienz entscheidend geworden.

Eine Studie von ThinkHDI¹ zeigt, dass Selbsthilfekanäle im Durchschnitt nur 2,37 $ kosten, während persönliche Kanäle im Durchschnitt 15 bis 37 $ kosten.

Hier sind einige weitere Vorteile der technischen Dokumentation:

1. Verbessert die Kommunikation und Zusammenarbeit zwischen den Abteilungen, indem es als einzige Informationsquelle dient.
2. Steigert die Effizienz und Produktivität
3. Verbessern Sie die Kundenzufriedenheit mit Selbsthilfekanälen und schnellen Antworten.
4. Senkung der Kundendienstkosten durch Verringerung der Anzahl der Support-Tickets.
5. Es verkürzt die Lernkurve und erleichtert neuen Mitarbeitern den Einstieg.
6. Ermöglicht schnelle Entscheidungen
7. Liefert einen Fahrplan für künftige Projekte
8. Ideen aufzeichnen
9. Fördert die Wissensspeicherung

Arten von technischer Dokumentation

Die technische Dokumentation kann in zwei Haupttypen unterteilt werden::

1. Die Produktdokumentation umfasst System- und Benutzerdokumentation.
2. Die Prozessdokumentation umfasst Prozessbenchmarks und interne Abläufe

1. Produktdokumentation

Die Produktdokumentation enthält Informationen über das in der Entwicklung befindliche Produkt und gibt Hinweise zu seinen Anwendungsfällen.

Diese Informationen bestehen aus Produktanforderungen, Geschäftslogik, technischen Spezifikationen und Benutzerhandbüchern.

System-Dokumentation

Die Systemdokumentation bietet einen Überblick über den Rahmen der Produktentwicklung und ermöglicht es Produktentwicklern und anderen Beteiligten, die dahinter stehende Technologie zu verstehen.

Es besteht in der Regel aus Anforderungen, Spezifikationen, Quellcode, Architekturentwurf, Validierungsberichten, Authentifizierungs- und Testdetails sowie Wartungsanweisungen.

Benutzerdokumentation

Die Benutzerdokumentation wird für diejenigen erstellt, die das Produkt verwenden. Aber die Arten von Benutzern können unterschiedlich sein. Deshalb müssen Sie diese Dokumente auf der Grundlage verschiedener Nutzungskategorien und Kenntnisstände erstellen.

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

Bei dieser Art von Dokumentation handelt es sich um Anleitungen, Benutzerhandbücher, Installationsanleitungen, Dokumente zur Fehlerbehebung, Bedienungsanleitungen, häufig gestellte Fragen und Hilfsanleitungen.

2. Prozess-Dokumentation

Die Prozessdokumentation umfasst alle Inhalte, die im Hinblick auf den Aufbau und die Verwaltung der Prozesse der Produktentwicklung erstellt werden.

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

Der Grund für die Führung einer Prozessdokumentation ist die Verbesserung der Organisation und Planung der Entwicklungsphase.

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

Zur typischen Prozessdokumentation gehören Standardarbeitsanweisungen, Projektdokumentation, Prozesspläne, Testdaten, Weißbücher, Sitzungsprotokolle und auch die Unternehmenskommunikation.

Beispiele für technische Dokumentation

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

1. Spren Dokumentation

Spren ist ein Unternehmen, das APIs für Verbindungen mit gesundheitsbezogenen mobilen Anwendungen anbietet, um maßgeschneiderte und präzise biometrische Informationen zu liefern.

Aber das ist ein kniffliger Prozess, der einfach zu verstehende Fachartikel erfordert, die von einem Profi erstellt werden. So können die App-Unternehmen die Lösung nahtlos in ihre jeweiligen Projektzyklen integrieren.

Deshalb ist die Dokumentation von Spren ein großartiges Beispiel für richtig gemachte technische Dokumentation. Sie enthält eine Fülle von Bildern und Illustrationen, die den Kunden ansprechen und das Verständnis der Dokumentation erleichtern.

2. Spryker Dokumentation

Die Dokumentation von Spryker muss sich an verschiedene Benutzergruppen richten, darunter Programmierer und Techniker, die für die Installation und Wartung der Software zuständig sind. Und auch die Zielkunden, die Spryker für den Betrieb ihres Online-Shops nutzen werden.

Das bedeutet, dass ihre Dokumentation einen Inhalt haben sollte, der verschiedenen Bedürfnissen gerecht wird. Außerdem sollten sie sie entsprechend den technischen Kenntnissen des anvisierten Endnutzers entwickeln.

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

Wie man sieht, muss jede Person, die die Dokumentation nutzt, zunächst ihre Kategorie aus den drei Arten von Zielgruppen (Geschäftsanwender, Entwickler, Cloud-Ingenieure) bestimmen und dann eine Sammlung von Leitfäden auswählen.

Sobald der Benutzer den entsprechenden Bereich betritt, werden ihm die für seine Rolle und seinen technischen Kenntnisstand konzipierten Leitfäden angezeigt.

Wie Sie im obigen Beispiel der technischen Dokumentation sehen können, besteht das Hauptziel darin, sicherzustellen, dass Programmierer und andere Benutzer die von ihnen gesuchten Anleitungen leicht finden können.

3. Metric Insights Hilfe & Dokumentation

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

Anhand ihrer technischen Benutzerdokumentation können Sie sehen, wie sie mehrere Szenarien abgedeckt haben.

Von der Verwendung eines Produkts aus der Perspektive eines normalen Benutzers bis zur Perspektive eines Administrators.

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

Wie man technische Dokumentation erstellt

Schritt 1: Bestimmen Sie die Anforderungen und die Art der zu erstellenden Inhalte

Überlegen Sie bei der Planung der technischen Dokumentation , 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 ihre Erstellung zu investieren.

Eine unzureichende technische Dokumentation kann den Gesamtnutzen beeinträchtigen. Andererseits verwirrt es Sie, wenn Sie mehr als genug Informationen haben.

Hier sind die Arten von Inhalten, die Sie für Ihre technische Dokumentation planen können:

• Produktumfang und Planung
• System-Dokumentation
• Quellcode, API-Dokumentation
• Anleitungen zur Fehlersuche und Wartung
• Änderungsprotokolle
• Anwendungsfälle
• Benutzerhandbücher
• Verfahrensdokumentation

Schritt 2: Technische Dokumentation schreiben

Der Nutzen Ihrer technischen Dokumentation hängt von der schriftlichen und didaktischen Qualität der Anleitungen ab, insbesondere wenn Sie sie zur Lösung von Kundenproblemen erstellen.

Im Folgenden finden Sie einige Tipps zum Verfassen hochwertiger technischer Dokumente:

2.1. Schreiben Sie für Ihr Publikum

Es ist sehr wichtig, das Publikum zu verstehen. Zum Beispiel würde es nicht funktionieren, einem Vegetarier nicht-veganes Essen zu servieren - oder doch?

Das Gleiche gilt für jede Art von Dokumentation.

Sie müssen Ihre Lehrmethoden auf die Zielgruppe abstimmen, für die Sie schreiben.

Werfen wir einen Blick auf das WordPress-Beispiel:

Beispiel für eine kundenorientierte WordPress-Dokumentation.

Beispiel für eine technische WordPress-Dokumentation.

Der Unterschied hier?

Zielgruppe: Die normale Dokumentation richtet sich an Redakteure, Blogger, Manager oder Personen ohne technische Kenntnisse.

Die technische Dokumentation wird für Entwickler, Ingenieure, Serverbetreiber oder technische Benutzer erstellt.

Inhaltlicher Unterschied: Die normale Dokumentation ist sehr einfach, kommt direkt auf den Punkt und enthält keine technischen Informationen.

Die technische Dokumentation enthält viele Informationen, verlinkte Ressourcen, Code und Beispiele aus der Praxis, wie bestimmte Funktionen oder Parameter verwendet werden können.

Erforderliche Erfahrung: Die normale Dokumentation kann von jedem erstellt werden, der über Schreibkenntnisse und ein wenig Produktrecherche verfügt, während die technische Dokumentation die Mitarbeit eines Entwicklers oder Experten erfordert, um genau und nützlich zu sein.

2.2. Testen Sie das Produkt, den Code oder die Forschung gründlich

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

Normalerweise wird die Dokumentation für den Kunden von Kundendienstmitarbeitern oder einem Autor erstellt. Und es funktioniert.

Aber bei der technischen Dokumentation ist das anders. Man braucht mehr als ein Produkt- oder Codeverständnis.

Einsichten, die nur durch eine angemessene Beteiligung und Prüfung gewonnen werden können.

2.3. Beginnen Sie mit einer Gliederung

Die Erstellung einer Gliederung vor einem Leitfaden oder Tutorial nimmt nicht viel Zeit in Anspruch (in der Regel 1 Stunde), kann aber in den späteren Phasen der Inhaltserstellung viel Zeit sparen.

Haben Sie sich jemals gefragt, warum Ihre Artikel/Leitfäden nicht gut klingen, nicht funktionieren oder keine professionelle Ausstrahlung haben?

Weil sie nicht gut geplant waren.

Im Folgenden finden Sie einige Punkte, die Sie mit Ihren technischen Dokumenten abdecken können:

1. Titel
2. Gezielte Schlüsselwörter oder häufigste Suchbegriffe
3. Benutzergeschichten (Als Benutzer möchte ich, also diese Formel)
4. Publikum, für wen es ist
5. Art des Artikels: Anleitungen, Artikel, Videos, Rezensionen oder Vergleiche zum Beispiel.
6. Ziele
7. Referenzartikel
8. Erwartete Wortzahl
9. Kurze Gliederung (oder Inhaltsverzeichnis): Umfang des Themas, vorhandene Ressourcen und Struktur des Artikels.

2.4. Halten Sie es einfach (verwenden Sie Vorlagen), und fügen Sie keine Flusen hinzu

Das Hinzufügen nur notwendiger Informationen sollte einer der wichtigsten Punkte in Ihrem Leitfaden für die Erstellung technischer Dokumentation sein.

Außerdem können Sie auf der Grundlage Ihrer Erfahrungen und Tests Vorlagen (Artikelvorlagen) erstellen, die sich für die Art der von Ihnen erstellten Inhalte am besten eignen.

1. Vermeiden Sie die Verwendung von Fachbegriffen, und wenn es sich nicht vermeiden lässt, erklären Sie sie.
2. Absätze kurz halten
3. Gliederung des Inhalts durch Überschriften, Zwischenüberschriften, Listen, Tabellen und Bilder
4. Vermeiden Sie übermäßige Erklärungen und entfernen Sie Fluff-Inhalte so weit wie möglich.

2.5. Visuelle Hilfen verwenden

Visuelles macht den Unterschied, vor allem wenn es darum geht, technische Konzepte leicht verständlich zu machen.

Das kann ein einfacher Screenshot, eine Kritzelei, eine Zeichnung oder eine gut gestaltete Grafik sein. Hauptsache, es hilft!

2.6. Fügen Sie, wann immer möglich, Beispiele und Referenzen hinzu

Bei der technischen Dokumentation geht es darum, komplexe Informationen zu dokumentieren und aufzuschlüsseln.

Das Hinzufügen von Beispielen und die Verlinkung relevanter Quellen, wann immer dies möglich ist, hilft dabei.

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

• Codeverwendung (wie eine bestimmte Funktion oder ein Parameter verwendet werden kann)
• Produkte oder Software-Anwendungsfälle. Vor allem, wenn es mehrere Möglichkeiten gibt.
• Wie eine bestimmte Sache oder ein bestimmtes Merkmal implementiert wurde, oder wie es ein Wettbewerber getan 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.

Die Erstellung 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 Meinung ein.

Um die Arbeit zu erleichtern, sollten Sie Kollaborationssoftware wie Kanban-Boards, Slack und Google Docs verwenden.

2.8. Style Guide für technisches Schreiben erstellen

Wenn Sie mit der Erstellung Ihrer technischen Inhalte beginnen, sollten Sie einen Leitfaden für den Schreibstil erstellen, der für Sie am besten geeignet ist.

Es hilft, Wissen zu bewahren, Konsistenz zu schaffen und die Qualität der Inhalte zu erhalten.

Ihr Leitfaden kann zum Beispiel Folgendes enthalten:

1. Zielgruppenprofil oder Zielpublikum
2. Schreibstil und Tonfall
3. Grammatik- und Anwendungsregeln
4. Formatierungsrichtlinien Terminologie
5. Struktur des Dokuments
6. Visuelle Leitlinien
7. Normen für die Zugänglichkeit
8. Links und externe Referenzpolitik
9. Überprüfungs- und Genehmigungsverfahren
10. Tools und Ressourcen

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

Schritt 3: Erstellung einer Website für technische Dokumentation

🤯, ich weiß, ich weiß.

Wenn Sie den Leitfaden bis jetzt verfolgt haben, ist das eine Menge, was Sie aufnehmen müssen. Aber ich empfehle Ihnen, etwas Zeit zu investieren, um Ihre Inhalte zusammenzustellen.

Denn das ist es, was Ihre technische Dokumentation für Sie und Ihre Benutzer normal und nicht technisch macht.

Denken Sie daran, dass Sie nicht von Anfang an das Beste anstreben müssen, da Erfahrung, Tests und Feedback sehr wichtig sind, um etwas Nützliches zu schaffen.

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

3.1. WordPress Website erstellen

Wir erstellen eine spezielle Website für technische Dokumentation oder ein Portal, auf dem Sie alle Ihre privaten und öffentlichen Dokumente hosten und pflegen können.

Warum eine Website für die Dokumentation erstellen?

1. Kundenspezifisches Branding
2. Bessere Nutzererfahrung
3. Zentraler Zugang
4. Erweiterte Funktionen wie Integration, Analyse, Versionskontrolle und Verwaltung.
5. Vollständige Kontrolle

Ich empfehle dringend WordPress mit Heroic Wissensdatenbank (Heroic KB) für die Dokumentations-Website, und genau das werden wir für dieses Tutorial verwenden.

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

Heroic KB ist ein Premium-WordPress-Plugin, mit dem Sie jede Art von Dokumentations-Website erstellen können.

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 (einschließlich Webhosting, Cloud-Hosting und dedizierten Servern) installieren.

Um die Dinge zu vereinfachen, verwenden Sie verwaltete WordPress-Hosting-Plattformen wie Kinsta.

Schauen Sie sich außerdem diese Anleitung an, wenn Sie vorhaben, WordPress manuell zu installieren, oder bitten Sie einfach Ihren Hosting-Anbieter, WordPress für Sie zu installieren.

3.2. Website zur Dokumentation erstellen

Nachdem Sie nun eine WordPress-Website eingerichtet haben, installieren Sie das Plugin Heroic KB , um die für Ihr Dokumentationsportal erforderlichen Funktionen zu erhalten.

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

1. Gehen Sie rüber zu WordPress Dashboard (auf die Sie zugreifen können, indem Sie /wp-admin an das Ende der URL Ihrer Website)
2. Klicken Sie auf oder fahren Sie mit dem Mauszeiger über das Feld 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. Aktivieren Sie nach der Installation das Plugin.

Sobald das Plugin aktiviert ist, wird Ihnen ein Assistent zur Einrichtung der Heroic Knowledge Base angezeigt.

Befolgen Sie die Anweisungen zum Importieren der Demo-Site wie hier gezeigt: https://heroickb.herothemes.com/

Hinweis: Sie können den Einrichtungsassistenten über den Abschnitt Plugins aufrufen, wenn Sie ihn während des Installationsvorgangs nicht abgeschlossen haben.

Ihre Dokumentations-Website ist nun fertig und kann über das Frontend unter yourdomain.com/knowledge-base/.

3.3. Benutzerzugang und Rollen

Mit WordPress und Heroic KB haben Sie alle notwendigen Optionen, um den Benutzerzugang und die 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 Einstellungen von Heroic KB , so dass die Dokumentation nur für den internen Gebrauch bestimmt ist, oder Sie haben für jeden Artikel die Möglichkeit, sie intern oder öffentlich zu machen.

WordPress → Heroic KB → Einstellungen

3.4. Anpassung

Mit einer Software für die technische Dokumentation wie Heroic KB haben Sie alle Möglichkeiten, die Dokumentation an den Stil Ihrer Marke oder Ihre Vorlieben anzupassen.

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

Zum Beispiel, um das Farbschema der Dokumentation zu aktualisieren:

So aktualisieren Sie die Layout-Einstellungen:

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

Mit dem Kauf von Heroic KB erhalten Sie ein Premium-Theme von Heroic KnowAll , das Ihnen grenzenlose Anpassungsmöglichkeiten bietet, ohne dass Sie eine einzige Zeile Code schreiben müssen.

Schritt 4: Veröffentlichung und Verwaltung von Dokumenten

Nun, da wir einen Inhalt und ein Portal bereit haben, müssen Sie nur noch Ihren Inhalt hinzufügen und veröffentlichen.

Sie können alle Ihre Artikel, Kategorien und Tags über WordPress → Heroic KB verwalten.

Um einen neuen Artikel hinzuzufügen , klicken Sie auf oder bewegen Sie den Mauszeiger über Heroic KB → Neuen Artikel hinzufügen.

Und so sieht Ihr Artikelerstellungsbildschirm aus:

Es ist ein sehr einfach zu bedienender und flexibler Editor, wenn man sich erst einmal eingearbeitet hat.

Außerdem erhalten Sie zusätzliche Blöcke von Heroic KB , mit denen Sie ganz einfach ein Inhaltsverzeichnis, einen Umschalter, ein Akkordeon, Registerkarten, einen Code-Block oder die Weitergabe wichtiger Informationen erstellen können.

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

Schritt 5: Optimieren Sie weiter

Die Fertigstellung der technischen Dokumentation endet nicht mit der Veröffentlichung der Inhalte.

Es handelt sich um einen kontinuierlichen Verbesserungsprozess, bei dem die Dokumentation genutzt wird, um auf dem Wissen des Unternehmens aufzubauen, das Rad nicht neu zu erfinden und die Prozesse zu rationalisieren.

Für den Anfang erfahren Sie hier, wie Sie Ihre technische Dokumentation optimieren können:

1. Rationalisierung der Erstellung und Verwaltung von Inhalten
2. Erstellung und Verbesserung von Leitlinien für die technische Dokumentation auf der Grundlage von Nutzerfeedback
3. Gewährleistung einer einfachen Navigation und eines einfachen Zugriffs auf die Dokumentation
4. SEO-Optimierung
5. Regelmäßige Backups durchführen

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

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

Tools und Software für die technische Dokumentation

Ich werde mich hier kurz fassen, da wir bereits sehr ausführliche Leitfäden über Werkzeuge für die technische Dokumentation und Werkzeuge für das technische Schreiben haben.

Diese empfohlenen Tools werden Sie bei der Erstellung, Verwaltung und Optimierung der technischen Dokumentation erheblich unterstützen.

WordPress + Heroic KBHeroic KB ist ein beliebtes, wirtschaftliches und kollaboratives System zur technischen Dokumentation. Es ist für eine breite Palette von Branchen und Produkten geeignet.

Damit lassen sich die meisten der für Ihre technische Dokumentation erforderlichen Funktionen problemlos erfüllen.

Mammut .docx Konverter: Ein WordPress-Plugin, mit dem Sie ganz einfach Dokumente 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 weniger als 5 Minuten mit diesem Tool. So einfach ist es, Inhalte mit WordPress zu veröffentlichen.

Github: Wahrscheinlich kennen Sie diese Seite bereits. Sie können es auch für die technische Dokumentation nutzen. Es verfügt über eine eigene Wiki-Plattform, die für 5-20 Dokumentationen ausreicht.

Figma: Es ist eine webbasierte Design-Software, die einfach zu bedienen und sehr flexibel ist.

Ähnlich wie WordPress verfügt es über eine Vielzahl von Plugins zur Erweiterung der Funktionalität, Vorlagen für die schnelle Erstellung von Grafiken und Funktionen für die Zusammenarbeit. Es ist eines der besten kostenlosen Tools, die es gibt. Probieren Sie es aus!

Google Docs: Sie brauchen eine einfache Möglichkeit, um Inhalte zu erstellen und gleichzeitig mit dem Team zusammenzuarbeiten, und Google Text & Tabellen ist dafür die beste Lösung.

FastStone Capture: Ein Premium-Tool zum Erfassen und Aufzeichnen von Bildschirmen. Sie können Anmerkungen über Bilder hinzufügen und sie mit anderen erstaunlichen Funktionen bearbeiten. Es kommt mit einer lebenslangen Lizenz, die es absolut wert ist!

MkDocs: Eine großartige Plattform zur kostenlosen Erstellung statischer Websites für technische Dokumentation. Es gibt viele gute Themes und Plugins, um das allgemeine Aussehen und die Funktionalität zu verbessern, aber es erfordert Entwicklungsfähigkeiten.

Häufig gestellte Fragen zur technischen Dokumentation

Hier finden Sie die Antworten auf die am häufigsten gestellten Fragen zum Thema technische Dokumentation.

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 einer technischen oder nichttechnischen Zielgruppe verwendet werden. Diese Dokumentation hilft den Benutzern zu verstehen, wie das Produkt funktioniert, wie man es installiert, benutzt und Fehler behebt, und wie man Teile repariert oder ersetzt, falls dies erforderlich ist.

Die 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 eine historische Aufzeichnung der Produktentwicklung und -evolution zu erstellen.

Wie organisiert und strukturiert man die technische Dokumentation?

Im Folgenden finden Sie einige bewährte Verfahren für die Organisation und Strukturierung der technischen Dokumentation:

• Beginnen Sie mit einem Inhaltsverzeichnis oder einem Index, um sich einen Überblick über die behandelten Themen zu verschaffen.
• Gliedern Sie die Dokumentation in klare Abschnitte und verwenden Sie Überschriften und Zwischenüberschriften, um den Leser zu führen.
• Verwenden Sie eine klare, prägnante Sprache und vermeiden Sie Fachjargon, es sei denn, er ist unvermeidlich und wird ausführlich erläutert.
• Fügen Sie Beispiele und visuelle Hilfsmittel wie Diagramme und Screenshots ein, um komplexe Konzepte zu erklären.
• Verwenden Sie in der gesamten Dokumentation ein einheitliches Format und einen einheitlichen Stil, einschließlich Schriftgröße und -stil, Überschriften und Absatzabstände.
• Bieten Sie eine Suchfunktion oder einen Index an, um die Navigation zu erleichtern, insbesondere bei längeren Dokumentationsreihen.

Was ist der Unterschied zwischen technischer Dokumentation und Benutzerdokumentation?

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

Die technische Dokumentation ist für technische Benutzer wie Ingenieure, Entwickler und IT-Fachleute bestimmt. Sie enthält detaillierte Informationen über das Design, die Architektur und die technischen Spezifikationen des Produkts und wird zur Fehlerbehebung und Wartung verwendet.

Die Benutzerdokumentation hingegen richtet sich an die Endbenutzer, z. B. an Kunden und Mitarbeiter, die das Produkt oder die Dienstleistung nutzen. Sie enthält Informationen über die Verwendung des Produkts, einschließlich schrittweiser Anleitungen und visueller Hilfsmittel.

Resümee

Technisches Wissen ist ein wesentlicher Vorteil für die Leser. Sie müssen nützliche technische Artikel für alle entwickeln und veröffentlichen, darunter Dokumente für Softwareentwickler und das Testteam sowie Benutzerdokumentation.

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

Ein umfassendes technisches Wissensportal ist präzise, auf den Punkt gebracht und sachdienlich. Und genau dabei kann ein System zur Verwaltung der technischen Dokumentation wie Heroic KB helfen kann.

Mit den Inhaltsmanagement- und Teamwork-Funktionen von Heroic KBkönnen Sie Ihren Erstellungsprozess und Ihre technischen Handbücher problemlos verbessern. Und Sie steigern die Produktivität Ihres Unternehmens und das Engagement der Benutzer.

In diesem Tutorial erwähnte Ressourcen

1. Die Service-Desk-Kennzahl "Kosten pro Ticket" von ThinkHDI verstehen ︎