Produktdokumentation
Helfen Sie Nutzern, die von Ihrer Anwendung unterstützten Aufgaben zu erledigen
Geben Sie Nutzern praktische Leitfäden, die die Abläufe der Anwendung erklären und ihnen helfen, ihre Aufgaben zu erledigen.
Machen Sie aus Produktfunktionen praktische Anleitungen
- Umfang des Leitfadens vorbereiten
Prüfen Sie die Dokumentationsabschnitte und ihre vorgesehene Zielgruppe.
- Inhaltsfragen beantworten
Klären Sie die Abläufe und Informationen, die ein Leitfaden erklären soll.
- Den öffentlichen Dienst verfolgen
Sehen Sie den Baufortschritt und die Adresse der Dokumentationswebsite ein.
Erklären Sie, wie man die Anwendung nutzt
Die Dokumentation ergänzt eine Produktpräsentation um praktische Anleitungen. Beginnen Sie mit den ersten Schritten und führen Sie Nutzer dann durch die Abläufe, die die Anwendung tatsächlich unterstützt.
Die Dokumentationskonfiguration zeigt die Abschnittsdefinitionen und Fragen. Liefern Sie Kontext, der hilft, eine Aufgabe in der Sprache der Nutzer zu erklären.
Halten Sie den Leitfaden mit der laufenden Anwendung verbunden
Eine erste nützliche Aktion unterstützen. Ein Leitfaden für die ersten Schritte gibt neuen Nutzern einen kurzen Einstieg ins Produkt. Er soll erklären, wo man beginnt, welche Informationen nötig sind und welches Ergebnis bestätigt, dass die Aufgabe erledigt ist.
Einen wiederkehrenden Ablauf erklären. Ein ausführlicher Leitfaden folgt den echten Bezeichnungen und Aktionen der Anwendung. Voraussetzungen, nummerierte Schritte und ein erwartetes Ergebnis helfen, eine Geschäftsaufgabe zu wiederholen, ohne eine allgemeine Bildschirmbeschreibung deuten zu müssen.
Eine übergreifende Frage beantworten. Manche Fragen betreffen Konten, Kosten oder Veröffentlichung statt eines einzelnen Bildschirms. Eine FAQ gibt eine knappe Antwort und verweist auf den passenden Leitfaden, sodass der Ablauf an einer Stelle bleibt, statt auf der Website dupliziert zu werden.
Halten Sie die Leitfäden mit dem Produkt verbunden
Prüfen Sie die Dokumentation nach einer wesentlichen Änderung der Anwendung. Ein Leitfaden soll die Bezeichnungen und das Verhalten verwenden, die Nutzer tatsächlich sehen.
Die Dokumentation läuft auf einem eigenen öffentlichen Dienst. Verlinken Sie sie von der Website und prüfen Sie die Leitfäden in den Sprachen, die Ihr Projekt veröffentlicht.
Helfen Sie Nutzern, die nächste Aufgabe zu erledigen
Ein praktischer Leitfaden erklärt, wo man beginnt, welche Informationen nötig sind und wie man das Ergebnis prüft. Sein Wert liegt darin, Lesern beim Handeln in der Anwendung zu helfen.
Nutzen Sie verwandte Leitfäden, um den Weg fortzusetzen, wenn die Aufgabe mehrere Bereiche berührt. Prüfen Sie die Dokumentation, wenn sich ein Bildschirm ändert, damit die Anleitungen nach einer Weiterentwicklung nützlich bleiben.
Von vereinbarten Funktionen zu nützlicher Hilfe
Umfang des Leitfadens vorbereiten. Prüfen Sie die Dokumentationsabschnitte und die Aufgaben, die sie erklären sollen. Halten Sie den vorgesehenen Nutzer und das Verhalten der Anwendung klar.
Fehlenden Kontext liefern. Beantworten Sie Fragen zu Voraussetzungen, Regeln und Ergebnissen. Die Texte sollen die echte Oberfläche verwenden, keine erfundenen Steuerelemente.
Nach Veröffentlichung und Änderung prüfen. Folgen Sie einem Leitfaden in der Anwendung, prüfen Sie seine Sprachen und verwandten Links und überarbeiten Sie ihn, wenn sich die zugrunde liegende Aufgabe ändert.
Machen Sie das Produkt nach dem ersten Besuch leichter nutzbar
Bieten Sie Anleitungen, die zu einem Ergebnis führen, neben der öffentlichen Darstellung dessen, was die Anwendung leistet.
Fragen zur Produktdokumentation
Eine Funktionsseite hilft Interessenten, die Funktion und ihren Nutzen zu verstehen. Ein Leitfaden hilft Nutzern, die Aufgabe mit den tatsächlichen Steuerelementen, Voraussetzungen und dem Ergebnis auszuführen. Beide ergänzen sich.
Die Dokumentationswerkzeuge zeigen Abschnittsdefinitionen und Fragen. Prüfen Sie die Aufgaben, die die Anwendung unterstützt, liefern Sie den fehlenden Kontext und verfolgen Sie den Schreibfortschritt.
Das Projekt veröffentlicht die lokalisierten Leitfäden, die für seinen Umfang verfügbar sind. Prüfen Sie jede veröffentlichte Sprache, damit sie den vollständigen Ablauf und die richtigen Oberflächenbezeichnungen behält.
Nach einer Änderung, die die Aufgabe, ihre Steuerelemente oder das erwartete Ergebnis betrifft. Prüfen Sie den Text an der laufenden Anwendung, statt anzunehmen, dass die ursprünglichen Anleitungen gültig bleiben.
Eine Endpunkt-Referenz gehört zu einem Projekt mit einer aktiven, funktionierenden API. Nutzen Sie ihre aktiven Vorgänge und die tatsächliche Referenz. Geplante Routen reichen nicht, um eine nutzbare Integration zu dokumentieren.