6 Beispiele und Best Practices der besten Software -Dokumentation

Möchten Sie den Erfolg hinter guten, florierenden Softwareprodukten kennen?

Es ist ihre Dokumentation.

Gute Unternehmen investieren viel in ihre Software -Dokumentation. Tatsächlich erstellen Sie als erstes Dokumentation, das den Zweck, den Umfang der Software, die Arbeit und die Branchenreferenzen enthält.

Auf diese Weise können Stakeholder einen Einblick in die Softwareentwicklungskosten, die Zeitleiste, der Marketingwinkel und die Strategien, die Funktionalität und die wichtigsten Funktionen werfen.

Es hilft nicht nur bei der Entwicklung, sondern auch bei der Software -Dokumentation eine der am häufigsten verwendeten Methoden für die Schulung neuer Mitarbeiter, die Onboarding neuer Kunden und die Unterstützung von Unterstützung.

Wir haben auch mehrere Software und deren Dokumentation erstellt. Daraus können wir Sie mit Ihrer Software -Dokumentation anleiten .

Also, lass uns anfangen!

Wir testen und recherchieren jedes Produkt, das wir über Herotheme empfehlen, rigoros. Unser Überprüfungsprozess. Wir können auch eine Provision verdienen, wenn Sie über unsere Links einen Kauf tätigen.

Was ist Softwaredokumentation?

Software -Dokumentation ist ein schriftliches oder Videomaterial, das die Softwareentwicklung hilft, Entwicklungsprozesse und Fortschritte aufzeichnet, wie eine Softwareanwendung funktioniert, Benutzer die Verwendung von Software effektiv nutzen und als Kundensupportmaterial dient.

Arten der Softwaredokumentation

Ein Softwareprojekt kann einige Tage bis ein paar Jahre dauern. Vor Beginn einer Business -Software ist es wichtig zu verstehen, worauf Sie eintauchen.

Infolgedessen deckt die Softwaredokumentation eine Vielzahl von Dokumentationen ab. Von der Planungsphase bis zur Einhaltung der Gesetze.

Einige der im Lebenszyklus der Softwareentwicklung erstellten Dokumente, Quelle - cds.cern.ch

Dies hilft Ihnen dabei, eine allgemeine Vorstellung davon zu erhalten, wie Sie Ihre Software -Dokumentation und Dinge starten können.

1. Projektdokumentation

Die Projektdokumentation wird in den ersten Phasen der Softwareerstellung erstellt und während des gesamten Lebenszyklus aufrechterhalten.

Da es den Birds im Blick auf den Softwareentwicklungsprozess gibt, hilft es bei der Entscheidungsfindung erheblich.

Es deckt Forschung, Tests, Ideen, Beispiele, Ressourcenzuweisung, Erfüllung von Details, Arbeitsfortschritt, Meilensteinen und zukünftige Ziele ab.

2. Anforderungen und Entwurfsdokumentation

Anforderungen und Entwurfsdokumentation arbeiten beide von Hand an Hand. Es ist wie eine grobe Skizze Ihrer Software zu erstellen, bevor Sie sie tatsächlich codieren.

Es enthält Schlüsselkomponenten wie:

• Überblick über das System
• Ziele und Ziele auf hoher Ebene
• Funktionale Anforderungen
• Akzeptanzkriterien
• Systemarchitektur
• Technologiestapel

Während die Anforderungen Dokumentation auf das konzentriert, was das System tun soll, konzentriert sich die Entwurfsdokumentation darauf, wie das System erstellt wird.

Best Practices: Es ist am besten, alle Ihre Anforderungen von der Software aufzulisten und in mehrere Phasen zu unterteilen. Auf diese Weise können Sie von Anfang an eine bessere Software entwerfen.

Viele Software werden neu gestaltet (z. B. in einer anderen Sprache umgeschrieben oder neu strukturiert), einfach weil sie überhaupt nicht ordnungsgemäß entworfen wurde.

3. Technische Dokumentation

Die technische Dokumentation deckt ab, wie Softwaresysteme erstellt, betrieben und gewartet werden.

In der Software -Dokumentation müssen Sie technische Dokumentation erstellen, um zu erklären:

• Wie Code funktioniert
• APIs (Anwendungsprogrammierschnittstelle)
• Datenbankschema (Tabellen, Beziehungen und Datenfluss)
• So upgrade Softwareabhängigkeiten auf
• Fehlerbehebung Guides

Wir haben einen vollständigen Leitfaden zum Erstellen und Schreiben von technischen Dokumentationen und schauen Sie es sich an!

4. Benutzerdokumentation

Benutzerdokumentation hilft Endbenutzern (Kunden) Ihre Software effektiv.

Es enthält:

• Benutzerhandbücher : Für Endbenutzer erstellt. Zum Beispiel, wie Benutzer eine bestimmte Funktion Ihres Produkts verwenden können.
• Schulungsmaterial: Es enthält verschiedene Trainingsressourcen für Endbenutzer. Zum Beispiel Setup Guides, Videos oder Kurse.

Benutzerdokumentation unterscheidet sich etwas von einer technischen Dokumentation. Wir haben einige Anleitungen, mit denen Sie mehr darüber erfahren können:

• 5 Beispiele für Benutzerdokumentation (Good & Bad + Tipps)
• So erstellen Sie ein Benutzerhandbuch: von Null zum Helden (Full Guide)

5. Testdokumentation

Testen von Dokumentation oder Richtlinien, die speziell für die QA -Teams (Quality Assurance) erstellt wurden. Um sicherzustellen, dass die Softwarequalität den Marktstandards entspricht oder den Anforderungen der Stakeholder erfüllt.

Es enthält:

• Testplan- und Testfälle
• Checklisten, die beim Testen einer Softwarefunktion folgen sollen
• Codequalitätsrichtlinien
• Automatisierte Tests

6. Wartungs- / Sicherheitsdokumentation

Diese Art von Dokumentation hilft Entwicklern und Teams, die Software zu pflegen, zu aktualisieren, zu debuggen und zu beheben.

Es enthält:

• Aktualisieren Sie Richtlinien oder Checklisten
• Anleitungen zur Aktualisierung von Softwareabhängigkeiten
• Zugangskontrollen
• Vorfallplan
• Versionshinweise

7. Rechts- und Compliance -Dokumentation

Rechts- und Compliance -Dokumentation, um sicherzustellen, dass Software rechtliche, regulatorische und branchenweit Standards folgt.

Rechtsdokumente wie:

• Endbenutzer-Lizenzvereinbarung (EULA)
• Nutzungsbedingungen (TOS)
• Datenschutzrichtlinie
• Software -Lizenzen und Nutzungsinformationen

Compliance -Dokumente wie:

• Datenschutz und Einhaltung der Datenschutz, die Vorschriften wie DSGVO, CCPA oder HIPAA enthält.
• Sicherheitsvorschriften
• Einhaltung der Zugänglichkeit
• Branchenspezifische Vorschriften

Explore : Was ist Softwaredokumentation?

6 Beispiele für Software -Dokumentation

1. WordPress

Wahrscheinlich haben Sie bereits WordPress verwendet, daher ist dies möglicherweise das beste Beispiel für Software -Dokumentation, aus dem Sie lernen können.

WordPress wird für 43% aller Websites im Web verwendet. Seine Dokumentation muss also eine der besten sein, um Millionen von Menschen aus der ganzen Welt zu dienen.

Dazu gehören Entwickler, Designer, Blogger, Schriftsteller oder jeden, der eine Website erstellen möchte.

WordPress -Hauptdokumentation ist in drei verschiedene Abschnitte unterteilt :

1. Lernen Sie WordPress: Enthält Leitfäden in Form von ausführlichen Kursen, Videos und geschriebenen Tutorials. Gekrönt auf Anfänger, mittlere und fortgeschrittene Benutzer.
2. Hauptdokumentation: Abzielt auf normale Benutzer. Um einen Überblick über WordPress -Merkmale in Form von kurzen, unkomplizierten Tutorials zu geben.
3. Entwicklerressourcen: Ziel für Entwickler, die WordPress -Themen, Plugins erstellen oder WordPress mit benutzerdefinierter Codierung erweitern möchten. Es umfasst Startführer, API -Dokumentation und Codierungsbeispiele.

Insgesamt schafft es einen perfekten Ressourcenzentrum für alle, die eine Website erstellen oder mit WordPress beginnen möchten. Es ist einfach, navigieren, suchfreundlich, ausführlich, voller Beispiele und sehr nützlich.

Dinge, die aus der WordPress -Software -Dokumentation zu lernen sind:

• Sie kennen ihr Publikum . Daher können Sie mehrere Dokumentationsabschnitte und -anleitungen sehen, die auf der Grundlage von Nutzerwissenstufe oder -kompetenz erstellt wurden .
• Kontinuierliche Updates . Softwaredokumentation ist keine einmalige Sache, Softwarefunktionen, Benutzeroberfläche oder Funktionalität können sich im Laufe der Zeit ändern. Das gleiche geschah mit WordPress (vom klassischen Thema zum Blockieren von Themen und Gutenberg Addition) und sie haben ihre Dokumentation mit jedem Update aktualisiert.
• Unterstützen Sie Foren . Abgesehen von vorgefertigten Tutorials und Leitfäden enthält WordPress auch ein Support -Forum für jedes Plugin und das Thema. Dies ist sehr hilfreich, falls Benutzer Probleme haben, selbst Probleme zu lösen.
• SEO (Suchmaschinenfreundlichkeit) . In meiner mehr als 9 -jährigen Karriere als WordPress -Benutzer habe ich selten die WordPress -Dokumentation direkt besucht oder stöbert. Ich habe nur bei Google gesucht und ich fand die Lösung für meine Fragen. WordPress-Dokumente und benutzergenerierte Supportseiten werden leicht in Google (oder anderen Suchmaschinen) indiziert, mit denen Sie sie leicht finden können.
• FAQs . Meistens werden FAQs in der Dokumentation übersehen. Aber WordPress hat sie nicht verpasst. FAQs bieten sofortige Informationen oder eine Lösung und sind leicht zu scannen.
• Feedback -System . Sie können Feedback zu jeder Anleitung geben, was eine hilfreiche Funktion für die Suche nach veralteten und nicht hilfreichen Leitfäden ist.

Was Sie an WordPress -Dokumentation nicht mögen sollten:

• Keine mehrsprachige Dokumentation . Obwohl Sie leicht WordPress-Guides von Drittanbietern in Ihrer Sprache finden können. Aber ich wünschte, WordPress hätte einige Tutorials für beliebte Sprachen erstellt.

2. Herothemen Wissensbasis

Unsere eigene Software -Dokumentation.

Es ist nicht das beste Beispiel da draußen, aber da die meisten von Ihnen eine ähnliche Situation wie unsere haben:

• Keine Ahnung, wo ich anfangen soll
• Niedriges Budget

Es kann ein gutes Beispiel sein, aus dem man lernen kann.

Herothemes bietet Kundendienst -Support -Plugins, einschließlich der heldenhaften Wissensbasis, mit der Benutzer eine Wissensbasis oder Dokumentationswebsites ohne Codierungskenntnisse für die öffentliche und interne Verwendung erstellen können.

Dinge zu lernen aus dem Herothemes -Dokumentationsbeispiel:

• Erstellen Sie nur die erforderlichen Dokumentation und verbessern Sie sie. Herothemes haben nur sehr wenige Leitfäden, da die meisten Zielkunden eine Zwischenstufe sind (Entwickler, WordPress -Benutzer), und die Software ist sehr einfach und einfach zu bedienen.
• Inhaltsverzeichnis (TOC) . Angesichts einiger dieser Leitfäden hilft TOC bei der Suche nach den erforderlichen Informationen.
• Screenshots . Da die meisten von uns von Anfang an kein gutes Budget für die Dokumentation (insbesondere einen Designer zum Erstellen hochwertiger Visuals zuweisen) ersparen können, ist das Hinzufügen von Screenshots weitaus besser, als nichts hinzuzufügen. Die von Designer erstellten Grafik verleihen jedoch wirklich ein erstklassiges Gefühl.
• Dokumentation zur Unterstützung der Ticketverfolgung .

Es ist eine der heldenhaften KB -Analysefunktionen, um Support -Tickets zu verfolgen, die aus der Dokumentation stammen. Sehr hilfreich, um nicht hilfreiche, veraltete Inhalte zu finden.

• FAQs . Benutzer stellen viele häufig gestellte Fragen wie Rückerstattungsrichtlinien oder zukünftige Upgrades. Wenn Sie sie über die Dokumentation beantworten, können Benutzer sie problemlos mit einer Suchleiste und einem KI -Hilfeassistenten finden.
• KI -Hilfeassistentin . Ähnlich wie bei Suchleisten hilft AI Hilfsassistenten den Benutzern, leicht Antworten auf ihre Fragen zu finden. Es ist in den Dokumentationsinhalten geschult, daher sind die Antworten relevant und hilfreich.

Was man an Herothemes -Dokumentation nicht mag:

Da Herothemes mehrere Softwarelösungen anbietet, ist die Gruppierung in der Dokumentationsinhalt ein wenig durcheinander .

Wir haben einige Anleitungen, mit denen Sie eine Dokumentations -Website mit WordPress erstellen können:

• So erstellen Sie eine WordPress-Wissensbasis (Schritt-für-Schritt-Anleitung)
• So erstellen Sie eine interne Dokumentation

3. Dokumentation von Barn2 -Software -Portfolio -Dokumentation

Barn2 verkauft mehrere Softwareprodukte basierend auf WordPress und WooCommerce, die auf über 90.000 Websites verwendet werden.

Das Servieren mehrerer Software -Dokumentationen aus einem einzigen Portal kann eine Herausforderung sein, aber Barn2 macht es wunderschön.

Sie sollten sich auf jeden Fall mit dem Beispiel von Barn2 untersuchen, wenn Sie mehrere Produkte haben.

Dinge, die aus dem Beispiel für Scheun2 -Dokumentation gelernt werden müssen:

Barn2 hat ihre Support -Seite sehr sorgfältig gefertigt. Dies ist mit seiner allgemeinen Funktionalität und Nützlichkeit zu sehen.

Wenn Sie ihre Support -Seite besuchen, finden Sie eine herausragende Suchleiste mit der Option zur Auswahl eines bestimmten Produkts .

Häufig gestellte Fragen zu Vorverkäufen, Lizenzierung, Updates und technischen Problemen. Dies ist sehr engagiert, um mit der Interaktion zu interagieren und bietet auch schnelle Antworten .

Wenn die Suche keine Ergebnisse liefert, zeigt sie eine Möglichkeit, die menschliche Unterstützung zu erreichen.

Besprechen Sie über die Hauptdokumentation der Hauptsoftware:

• Sie finden alle wichtigen Leitfäden oben und die Führer werden in verschiedene Abschnitte unterteilt, um eine einfache Navigation zu erhalten.
• Enthält schriftliche und Video -Tutorials.
• Die menschliche Unterstützung ist mit der Sidebar CTA leicht zugänglich .
• Benutzerdefinierte Blöcke/Designs für Notizen, Tipps, Warnmeldungen und Code -Snippets zur Verbesserung der Scan -Fähigkeiten.

Was Sie an Barn2s Dokumentation nicht mögen sollten:

• Kein Feedback -System . Obwohl sie direkten Zugriff auf menschliche Unterstützung bieten, gibt es keine Möglichkeit, dass sie Echtzeit-Feedback von Benutzern sammeln. Dies kann zu veralteten Informationen und Tutorials führen.

Barn2 verwendet auch eine heldenhafte Wissensbasis , um ihre Softwaredokumentation zu erstellen.

4. iPhone -Benutzerhandbuch

Es gibt viele Dinge, die die Benutzerdokumentation des iPhone (iOS -Software -Führer) mögen und nicht mögen können.

Es ist eine schick aussehende Software-Dokumentation mit einfach zu befolgenden Anweisungen, so dass Sie so etwas von Apple erwarten können.

Dinge, die aus dem Dokumentationsbeispiel des iPhone lernen müssen:

Die Dokumentation der iPhones sieht umwerfend aus .

• Ein einzelnes Spaltenlayout
• Viel weißer Raum
• Kleiner Absatz und Inhalt
• Schöne Bilder
• Gute Verwendung von Überschriften, Listen und Trennwänden

Der größte Schwerpunkt ihrer Dokumentation liegt auf der Erstellung solcher visuell atemberaubenden und hilfsbereiten Guides.

Wenn Sie den relevanten Leitfaden finden, dauert es weniger als eine Minute, um sie durchzuführen und zu verstehen, was zu tun ist.

Die Dokumentation des iPhone wird speziell auf diese Weise erstellt, sodass jeder leicht verstehen kann.

Wenn Sie eine Produktsoftware -Dokumentation erstellen möchten, empfehle ich dringend, Benutzerhandbücher ähnlich dem iPhone zu erstellen, wenn Sie über ein Budget für die Dokumentation sparen können.

Abgesehen davon, dass Apple ihre Dokumentation verschönert, hat es nicht vergessen, SEO ordnungsgemäß zu verwenden . Spezifisch sein:

• Titel- und Überschriftenstruktur
• Verknüpfung in Form von TOC, verwandte Beiträge, vorherige und nächste Navigation

Das Feedback -System für Führungskräfte ist fantastisch . Sie klicken auf Ja oder Nein und geben Sie bei Bedarf auch Feedback.

Das Feedback -System klingt nicht so cool, aber wenn Sie Millionen von Benutzern haben, die Ihnen Feedback geben, ist ein einfaches Ja oder Nein -Tracking wirklich nützlich, um die Leistung von Führern zu überprüfen (Sie können einfach nicht all das Feedback durchlesen, oder?) .

Apple bietet auch Leitfäden basierend auf Softwareversionen (in diesem Fall iOS -Version).

Was Sie an der iPhone -Dokumentation nicht mögen sollten:

Ich habe viel über die obigen Dokumentation des iPhone gelobt , aber es gibt auch einige nervige Sachen.

Vor allem der Navigationsteil.

• Das Inhaltsverzeichnis ist nicht nützlich, da es alle Leitfadenlinks enthält.
• Das Suchsymbol ist zu klein, um bemerkt zu werden.

5. Software -Design -Dokument (internes Beispiel)

Die Softwaredokumentation beginnt mit der Idee, eine Software zu erstellen.

Zum Beispiel könnte Ihre erste Software -Dokumentation enthalten:

• Was sind die Anforderungen der Software
• Umfang
• Wie es funktionieren wird
• Referenzen

Durch detaillierte Informationen werden viele zukünftige Besprechungen vermieden, neue Mitarbeiter geschult und konkrete Richtlinien erstellen.

Sie können viel aus dem Road Trip Advisor -Software -Design -Dokument lernen.

Es beschreibt alle Anforderungen, die zum Erstellen von Software (in diesem Fall eine Webanwendung) erforderlich sind oder neuen Mitarbeitern helfen, die Anforderungen der Software zu verstehen.

Darüber hinaus können Sie es während der Softwareentwicklung immer verbessern.

Dinge zu lernen aus diesem Beispiel:

• Enthält grundlegende, aber wichtige Informationen wie Zweck, Umfang und Definitionen, die konkrete Richtlinien erstellen.
• Verwendung von Diagrammen und visuellen Grafiken , um Entwicklern dazu zu helfen, die Anforderungen besser zu verstehen. Zum Beispiel: Beschreibung von Verbindungen oder Fluss der Funktionalität mit Diagrammen.

6. Google -Dokumentation

Wer kennt Google nicht? Wir verwenden jeden Tag ihre Top-der-Line-Software, wie Chrome, Google Mail, Google Maps, Google Drive oder YouTube.

Sie stehen sowohl für Computer- als auch für mobile Geräte zur Verfügung. Verschiedene Betriebssysteme, Geräte, Auflösungen und Einstellungen.

In einer solchen Situation muss es ein Albtraum sein, etwas Gutes ohne Chaos zu schaffen. Und Google macht mit ihrer Dokumentation einen wirklich guten Job .

Dinge, die aus der Softwaredokumentation von Google lernen müssen:

• Großartige Verwendung von Registerkarten und Akkordeon, um Inhaltscluster zu vereinfachen.

Wenn Sie Software für mehrere Geräte erstellen, können Sie dies vermeiden, mehrere Dokumente zu erstellen.

• Fantastisches Feedback -System. Ähnlich wie einige der obigen Beispiele enthält Google auch ein Ja/Nein -Feedback -System, das auch Feedback von Benutzern sammelt.

Aber Google geht hier einen Schritt weiter. Sie haben ein System, das Feedback basierend auf bestimmten Abschnitten sammelt. Das ist sehr intuitiv und praktisch.

• Schneller Inhalt . Gehen Sie dorthin, klicken Sie darauf, laden Sie, installieren und boom. So fühlen sich die Tutorials für Google -Dokumentation schnell an.
• Top -Bars, um schnell auf Suche nach Such-, Hilfebedanz-, Community- und Produktseite zugreifen zu können.
• Dokumentation in mehreren Sprachen verfügbar.

Was Sie an Googles Dokumentation nicht mögen sollten:

Ich habe versucht, hier viel zu finden, aber am Ende konnte ich es nicht tun. Google hat eine gute Softwaredokumentation.

Letzte Gedanken

Wir haben viele verschiedene Beispiele in diesem Leitfaden für Software -Dokumentationsbeispiele behandelt und auch unsere persönlichen Erfahrungen geteilt.

Hier sind einige letzte Worte:

1. Wenn Sie mit der Erstellung von Software beginnen , erstellen Sie einige interne Leitfäden, die den Software -Zweck, den Umfang, die Funktionalität und die Freigabe von Kriterien beschreiben.
2. Erstellen Sie Ihr Dokumentationsportfolio , während Sie Software entwickeln . Zum Beispiel API -Dokumentation und technische Dokumentation.
3. Erstellen Sie vor dem Start der Software Benutzerdokumentation, die Setup -Guides, Anwendungsfälle, Funktionenübersicht und häufig gestellte Fragen enthält.
4. Erstellen Sie nach dem Start Tutorials, um die häufigsten Benutzerprobleme zu lösen und Ihre alte Dokumentation zu verbessern.

Dokumentation ist kein Scherz; Es kann Sie vor einer schrecklichen Software -Sanierung oder Neugestaltung von Prozessen ersparen. Ich kann Ihnen helfen, ein besseres Kundenerlebnis zu bieten und Kunden zu behalten.

Wenn Sie nach einer Software -Dokumentationslösung suchen, hat die Heroic Knowledge Base alles zu bieten, was wir in diesem Leitfaden besprochen haben.

Probieren Sie es aus!