Über den Service
ÜbersetztIch schreibe technische Dokumentationen und Produkt-Hilfen, die Menschen tatsächlich lesen: ein Benutzerhandbuch, ein Hilfecenter, eine API-Referenz. Die Arbeit beginnt damit, das Produkt auseinanderzunehmen. Ich gehe es so durch, wie es ein Neuling tun würde, notiere jeden Ort, an dem ich stecken geblieben bin, und sammle die realen Aufgaben, mit denen Ihre Benutzer ankommen. Die Struktur wächst aus diesen Aufgaben, nicht aus Ihrem Menübaum: zuerst der erste Start und der erste kleine Erfolg, dann die tägliche Arbeit, und erst danach die komplexen Szenarien, die nur wenige Menschen benötigen, aber die die meiste Zeit des Support-Teams in Anspruch nehmen.
Jeder Artikel ist eine Reihe von Schritten mit Screenshots, beschriftet, sodass der Leser nie raten muss, welcher Knopf gemeint ist. Ein separater Abschnitt behandelt häufige Fehler und was man dagegen tun kann: der Text auf dem Bildschirm, der Grund dafür, der Ausweg. Der API-Teil enthält Anfrage- und Antwortbeispiele für jede Methode, erklärt Felder und Statuscodes und sagt klar, was bei einem Fehler zurückkommt. Ein Glossar hält Produktbegriffe an einem Ort, sodass die Benutzeroberfläche, die Hilfe und die Support-Antworten die gleichen Wörter verwenden, und ein kurzer Stilleitfaden fixiert Ton und Formulierung, sodass der Text eine Stimme bleibt, auch wenn später andere Personen daran mitarbeiten.
Jede Anleitung wird überprüft, indem die Schritte im Live-Produkt durchgegangen werden; nichts, was aus dem Gedächtnis eines Entwicklers geschrieben wurde, ohne diesen Durchgang, kommt in die Hilfe. Schlüssel, Tokens und Testanmeldeinformationen in Beispielen werden durch Platzhalter ersetzt. Dokumentationen für ein unfertiges Feature werden als Entwurf gekennzeichnet und niemals als fertig ausgegeben.
— Produktdurchgang und eine Liste der realen Benutzeraufgaben
— Hilfestruktur vom ersten Start bis zu fortgeschrittenen Szenarien
— Schritt-für-Schritt-Anleitungen mit Screenshots und Beschriftungen
— ein Abschnitt über häufige Fehler und was man dagegen tun kann
— API-Referenz mit Anfrage- und Antwortbeispielen
— Glossar der Begriffe plus ein kurzer Stil- und Tonleitfaden
— jede Anleitung wird im Live-Produkt erneut überprüft
— Quellen werden in einem Format übergeben, das leicht weiter bearbeitet werden kann
Jeder Artikel ist eine Reihe von Schritten mit Screenshots, beschriftet, sodass der Leser nie raten muss, welcher Knopf gemeint ist. Ein separater Abschnitt behandelt häufige Fehler und was man dagegen tun kann: der Text auf dem Bildschirm, der Grund dafür, der Ausweg. Der API-Teil enthält Anfrage- und Antwortbeispiele für jede Methode, erklärt Felder und Statuscodes und sagt klar, was bei einem Fehler zurückkommt. Ein Glossar hält Produktbegriffe an einem Ort, sodass die Benutzeroberfläche, die Hilfe und die Support-Antworten die gleichen Wörter verwenden, und ein kurzer Stilleitfaden fixiert Ton und Formulierung, sodass der Text eine Stimme bleibt, auch wenn später andere Personen daran mitarbeiten.
Jede Anleitung wird überprüft, indem die Schritte im Live-Produkt durchgegangen werden; nichts, was aus dem Gedächtnis eines Entwicklers geschrieben wurde, ohne diesen Durchgang, kommt in die Hilfe. Schlüssel, Tokens und Testanmeldeinformationen in Beispielen werden durch Platzhalter ersetzt. Dokumentationen für ein unfertiges Feature werden als Entwurf gekennzeichnet und niemals als fertig ausgegeben.
— Produktdurchgang und eine Liste der realen Benutzeraufgaben
— Hilfestruktur vom ersten Start bis zu fortgeschrittenen Szenarien
— Schritt-für-Schritt-Anleitungen mit Screenshots und Beschriftungen
— ein Abschnitt über häufige Fehler und was man dagegen tun kann
— API-Referenz mit Anfrage- und Antwortbeispielen
— Glossar der Begriffe plus ein kurzer Stil- und Tonleitfaden
— jede Anleitung wird im Live-Produkt erneut überprüft
— Quellen werden in einem Format übergeben, das leicht weiter bearbeitet werden kann
