Anhang E: Artikelqualität-Schnellreferenz
Nachfolgend aufgeführt ist ein Beispiel einer Schnell-referenz für Artikelqualität, das auf die Umgebung abgestimmt werden sollte:
(Editierbares Word-Dokument hier)
Problem/Frage:
Aus der Sicht der Nutzbarkeit hilft es, klare, einzigartige Probleme oder Fragen zu sehen, wenn man nach Artikeln sucht. Problem: sag uns, was in den Worten des Fragenden passiert 1. Keine zusammengeklebten Aussagen – halt die Umgebungsbeschreibung so gut es geht aus der Problembeschreibung raus. Nicht: Problem: 3COM NIC X1000 hat die folgende Fehlernachricht: Comu.dll löst einen Fehler auf einer ungültigen Seite in Modul Comu.dll aus. Sondern: Problem: Fehler „Comu.dll löst einen Fehler auf ungültiger Seite aus“; Umgebung: 3Com X1000 Modul – Comu.dll 2. Bilde vollständige Gedanken: Ja: Problem: stürzt bei Hochfahren mit Fehler ab Problem: Fehler: „Programm stürzt wegen unzureichendem Speicherplatz ab“ Fehlernachrichten Fehler: „< genaue Fehlernachricht >“ Fehler: „Kann Programm nicht starten. Geforderte Anwendung nicht erkannt“ Reihenfolge der Probleme: wenn ein Artikel mehrere Problembeschreibungen hat, ordne sie wie folgt: - Weniger detailliertes zuerst (generisch) - Detaillierteres folgt (spezifisch) Beispiel: - Kann Dateien nicht drucken - Fehler beim Ausdrucken mit Netzwerkdrucker - Fehler: „Ungültiges Papierformat für den Druckertreiber. (24301)“ Der verwertbarste Fehler Fehlernachrichten-ähnliche Probleme zu erfassen ist die beste Chance zum Wiederverwenden, wenn die Probleme in zwei „Modulen“ strukturiert werden: 1. Generische Beschreibung, dass ein Fehler auftaucht und die Voraussetzungen unter denen er auftaucht. 2. Spezifische Fehlermeldung ohne bedingte Anpassungen Beispiel: Wenn ein Fragender berichtet, die folgende Fehlermeldung zu erhalten: Fehler: „Unzureichender Speicherplatz“; Error: „Fehler beim Erstellen von UDP Paket 8101“; Fehler: „Keine Bibliotheken verfügbar“ Dinge, die du nicht schreiben musst! Bestimmte Phrasen sind beim Beschreiben unnötig: - Ich möchte…, der Kunde versucht… - Der Kunde benutzt… - Der Kunde bekommt … - Es hat funktioniert, bis… Komm zum Punkt! Zeitform Schreib im Präsens: sag uns nicht was du gemacht hast, sondern was du tust! Nutze spezifische Subjekte Implizites Subjekt: druckt nicht (unklar- was druckt nicht?) Explizites Subjekt: Dokumente drucken nicht (besser) |
Umgebungsinformationen:
Benennt Plattform, Produkte, Versionen und/oder Funktionen. Umgebungsinformationen sollten formalisiert und detailliert sein und so viel Informationen wie nötig umfassen, um die beschriebene Umgebung eindeutig zu identifizieren. - <Hersteller>, <Produkt>, Version <Versionsnummer> Beispiele guter Umgebungsinformationen - OS X Yosemite Version 10.10.5 - Microsoft Office 2016 - MacBook Air Umgebungsinformationen helfen, Probleme zu klassifizieren 1. Packt nicht mehrere Umgebungen in eine Beschreibung 2. Passt bestehende Artikel an, indem ihr neue Umgebungen hinzufügt, wenn nötig: Umgebungsänderungen 1. Denkt über das nach, was der Anwender vielleicht getan hat: · Änderung: Die Aktualisierung der Software geladen · Änderung: den Zähler zurückgesetzt 2. Änderungen sind nicht Ursachen – verwechselt die beiden nicht 3. Springt nicht zu Feststellungen: · Nicht: Änderung: Es funktionierte, bevor wir die XBTVA mit der XBTVM getauscht haben · Sondern: Änderung: Aufgestockt von Veröffentlichung 3.2 auf 4.0 Fügt einzigartige Umgebungsbeschreibungen zu, um diesen Artikel von anderen mit ähnlichen Symptomen aber einer anderen Lösung zu unterscheiden.
Lösung:
Lösungen oder Antworten sollten das Problem beheben oder die Frage beantworten. - Die Lösungsbeschreibung zählt auf welche Schritte das Problem beheben - Es kann mehrere Wege geben, ein Problem zu lösen, eine formelle Lösung, eine Brückenlösung, die in der Lösungsbeschreibung beschrieben und als „Brückenlösung" bezeichnet werden sollten - Lösungsbeschreibungen sollten aktive Verknüpfungen zu gepflegten Webseiten, die für den Nutzer durchsuchbar und in ihrem Kontext sind, beinhalten. - Nutze eine Verknüpfung, wenn es hilft, für mehr Details auf andere Dokumente zu verweisen. Struktur einer Lösung - Belasse die gesamte Lösung in einer „Beschreibung“. Falls mehrere Schritte durchgeführt werden müssen, nummeriere sie. - Nutz Absätze für Format und Lesbarkeit - Schreib alles im Präsens als Liste von Anweisungen, als würdest du sie Schritt für Schritt dem Kunden vorlesen. - Keine „falls-dann“-Aussagen in Lösungen. Das ist ein Hinweis, dass du zwei verschiedene Artikel brauchst, die sich in der Umgebung unterscheiden - Der Artikel kann mehr als eine Lösungsbeschreibung enthalten - aber alle Lösungen müssen zutreffend sein. |
Ursache (optional):
Es sollte nur eine Ursache pro Artikel geben. Wenn ein Artikel mehr als eine Ursache hat, sollte er wahrscheinlich mehrere Artikel sein. Falls du dich zwischen der Anwendung eines Lösung oder einer anderen entscheiden musst (weil nur eine für deinen Kunden funktionieren wird), sollte der Artikel geteilt werden!
Artikel-Zielgruppe:
Zeigt an, wer welche Artikel sehen kann. Intern: nur für Nutzer sichtbar, die als Mitarbeiter identifiziert werden Partner: sichtbar für alle, die nicht Mitarbeiter sind, aber vertrauenswürdige Erweiterungen der Organisation sind. Kunden: Sichtbar für Kunden oder Nutzer unserer Produkte und Dienstleistungen. Öffentlich: sichtbar für unidentifizierte Individuen der Öffentlichkeit
Artikel-Zuversicht-Übergänge
Zeigt an, wie sich der Artikel durch den Zuversichts-Status bewegt. Entwurf: Stellt anhaltende Arbeit dar, keine Lösung bisher gefunden Nicht-validiert: Ein Artikel, den der Autor als vollständig ansieht, der aber keine hohe Zuversicht in die Lösung hat (nicht validiert). Oder der Autor ist ein KCS Anfänger und hat nicht die Lizenz validierte Artikel zu erstellen. Nicht-validierte Artikel können durch Wiederverwendung validiert werden. Validiert: einem Artikel zugewiesen, wenn der Beitragende zuversichtlich in die Lösung ist und in die Struktur des Artikels. KC Fortgeschrittene und Coaches können Artikel validieren. Archiviert: Dieser Artikel ist nicht länger relevant. Er ist ein Archivierungs-Kandidat.
Artikel-Regulierung:
Zeigt an, wer Änderungen an Artikeln vornehmen kann. Erfahrungsbasiert: Artikel kann durch lizensierte KCS-Nutzer verändert werden. Reguliert: Artikelerstellung und -anpassung ist auf bestimmte Individuen begrenzt. |