Diese Vorlage beschreibt Standards für das Schreiben von sachkundigen Artikeln. Verwenden Sie die Knowledge Base-Artikel von Apple als Beispiel: https://support.apple.com/en-ca/HT207935
Titel
Der Titel des Artikels muss den Inhalt des Artikels widerspiegeln, um eine einfache Wiedererkennung zu ermöglichen und die Suche zu erleichtern.
Beispiele: „Wie lösche ich einen Song?“, „Willkommen bei Anytune iPhone/iPad“
Richtlinien
- Vermeiden Sie es, doppelte Artikel zu erstellen. Suchen Sie sorgfältig, bevor Sie erstellen.
- Beginnen Sie mit "Überschrift 2" für Überschriften. Der Artikeltitel ist Überschrift 1 und es sollte nur eine geben.
- Produktnamen und Namen von Textschaltflächen in Großbuchstaben schreiben:
Tippen Sie auf die Schaltfläche Bearbeiten. Machen Sie keine fetten Befehle. - Verwenden Sie das Schaltflächentabellenbild (svg) mit einer Größe von 22 Pixeln, wenn die Schaltfläche ein Symbol verwendet:
Tippen Sie auf Wiederherstellen
- Verwenden Sie Anführungszeichen, um Optionen auszuwählen:
3. Wählen Sie "Gestimmter Song" und "E-Mail" - Um einer Hierarchie zu folgen, verwenden Sie:
Gehen Sie zu Anytune-Menü > Dateien > Konfigurationsexport > In Datei exportieren... - Verwenden Sie nummerierte Listen für Schritte in einem Verfahren.
Schritte enden in einer Periode. - Prozedurtitel sind H@ und enden mit einem Doppelpunkt. Beispiel: "Verfahrenstitel:"
- Wenn die Schritte für Produktversionen unterschiedlich sind, erstellen Sie mehrere Abschnitte mit den Überschriften der Beschreibungsüberschrift 3
- Verwenden Sie Aufzählungszeichen für Listen.
- Pflegen Sie den Kontext des Kunden
- Denken Sie an das Publikum
- Verweisen Sie nicht auf einen Kunden
- Verzichten Sie auf Abkürzungen und Akronyme
- Stellen Sie sicher, dass alle Links funktionieren
Etiketten
Fügen Sie den Artikeln entsprechende Etiketten bei. Labels beeinflussen die Relevanz der Artikelsuche und die Ergebnisse des Antwortbots. Sie können auch zum Erstellen von Artikellisten verwendet werden.
Verwenden Sie nach Möglichkeit einzelne Wörter und verwenden Sie keine Variationen desselben Wortes. Verwenden Sie Etiketten sparsam.
Beispiele: macOS, Import, Bluetooth, ReFrame
Schablone
Zusammenfassende Aussage dessen, was dieser Artikel Ihnen sagen wird.
Verwenden Sie Überschrift 3 für den Prozess und zur Unterscheidung von Plattformen
- Verfahrensschritte
- Tippen Sie auf die
Hilfe-Button - Wählen Sie "E-Mail"
- Tippen Sie auf Bearbeiten
Auf dem Mac ist der Prozess dafür
Hinweis: Machen Sie Notizen in <p class="anytune-note">note</p>
Warnung: Machen Sie Notizen in <p class="anytune-warning">notiz</p>
Hervorheben durch Hervorheben mit <p class="anytune-highlight">Hinweis</p>
Mehr erfahren (H3)
Teilen Sie dem Benutzer durch Links mit, wo sich weitere Informationen befinden.
So beheben Sie Probleme
Wenn der Artikel beschreibt, wie ein Problem behoben wird, fügen Sie diese Abschnitte hinzu
- Problem: Beschreiben Sie das Problem und versuchen Sie, die Worte des Kunden zu verwenden.
- Umgebung: Beschreiben Sie die Einrichtung und Konfiguration, für die dieser Fix gilt (optional)
- Lösung: Dies sind die Schritte zur Lösung
- Ursache: Welches Szenario hat das Problem verursacht oder verursacht?
- Labels: Fügen Sie Wörter ein, die sich auf den betreffenden Artikel beziehen, um zu helfen
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.