Wie dieses Hilfe-Center funktioniert
Warum manche Artikel sagen, dass eine Funktion nicht funktioniert, und wie sie geschrieben werden.
Auf dieser Seite
Zwei Dinge an diesem Hilfe-Center sind ungewöhnlich genug, um sie zu erklären.
Wir dokumentieren, was die App tut, nicht was sie tun soll
Mehrere Artikel hier sagen unverblümt, dass eine Funktion fehlt, halb fertig ist oder anderswo im Produkt beworben wird, aber tatsächlich nicht verfügbar ist. Die Schaltfläche für den Datenexport. Die Schalter für Benachrichtigungen. Der Bereich für Empfehlungen.
Das ist Absicht. Ein Hilfe-Center, das das gedachte Produkt beschreibt statt des ausgelieferten, ist schlechter als gar kein Hilfe-Center, weil es dich nach einem Bedienelement suchen lässt, das es nicht gibt, und dich in dem Glauben zurücklässt, du seist das Problem.
Wo es also eine Lücke gibt, sagt der Artikel das, sagt, was stattdessen passiert, und nennt dir einen Weg, das Ergebnis von Hand zu erreichen. Diese Artikel sind auf der Seite bekannte Lücken gesammelt.
Diese Artikel liegen neben dem Code
Hilfeartikel werden im selben Repository wie die Anwendung geschrieben und mit ihr ausgeliefert. Das ist ein Implementierungsdetail, das dich nicht interessieren müsste, bis auf eine Folge: Wenn eine Schaltfläche umbenannt wird, ändert sich der Artikel, der sie beschreibt, im selben Arbeitsschritt. Es ist der günstigste Weg, den wir kennen, um zu verhindern, dass Dokumentation in Fiktion abdriftet.
Jeder Artikel trägt das Datum, an dem er zuletzt geprüft wurde.
Was wir nicht schreiben
Wir beschreiben keine Funktion, die es noch nicht gibt, wie nah sie auch sein mag. Wenn sie nicht im Produkt ist, fehlt sie entweder auch hier oder sie ist ausdrücklich als fehlend gekennzeichnet.
Wir nennen keine Veröffentlichungstermine. Nirgends steht hier „demnächst“ mit einem Monat dahinter, denn ein verpasster Termin ist schlechter als gar kein Termin.
Wir füllen nicht auf. Wenn die Antwort ein Absatz ist, ist der Artikel ein Absatz.
Wenn ein Artikel falsch ist
Sag es uns. Am Ende jedes Artikels gibt es ein Bedienelement „was this helpful?“, und ein Nein öffnet dir ein Feld für die Begründung. Das geht an dieselbe Stelle wie eine Support-Nachricht, und ein Mensch liest es.
Wenn ein Artikel der App widerspricht, hat die App recht und der Artikel ist ein Fehler. Solche Fehler werden schnell behoben.