Erstellen eines Style Guide für die Wissensdatenbank

Das Schreiben einer Wissensdatenbank ist schon schwer genug. Deshalb entschuldige ich mich für das, was ich in diesem Beitrag tun werde. Ich werde Ihnen sagen, dass es nicht nur um die Ideen in Ihrer Wissensdatenbank geht, sondern auch darum, wie Sie sie präsentieren.

Abgesehen von diesen Ideen müssen Sie sicherstellen, dass Sie immer präsent sind:

• Den richtigen Ton treffen
• Alles einheitlich formatieren

Was aus Gründen, die ich im nächsten Abschnitt erläutern werde, tatsächlich erstaunlich schwierig ist. Hier kommt ein Style Guide für die Wissensdatenbank ins Spiel.

Warum Ihre Wissensdatenbank ein Wirrwarr aus verschiedenen Stilen sein kann

Machen Sie sich nicht zu viele Sorgen, wenn Ihre Wissensdatenbank ein Wirrwarr verschiedener Stile ist. Das passiert vielen Unternehmen, meist aus einem von zwei Gründen (oder manchmal aus beiden!).

Erstens: Wenn Sie Teil eines Teams sind, kann es sein, dass verschiedene Personen Support-Dokumente schreiben. Wenn also:

• Jim schreibt Artikel A
• Sally schreibt Artikel B

Diese Artikel werden wahrscheinlich sehr unterschiedliche Stile und Formatierungen aufweisen... es sei denn, Sie haben einen vordefinierten Stil-Leitfaden erstellt.

Wenn Sie nicht Teil eines Teams sind, sagen Sie wahrscheinlich : "Ich bin ein Einzelkämpfer - ich schreibe alles selbst. Ich brauche also nichts zu Papier zu bringen - das ist alles meine Sache!"

Und das könnte der Fall sein... wenn Sie alle Artikel Ihrer Wissensdatenbank in einer Sitzung schreiben würden.

Aber wir wissen beide, dass die Dinge normalerweise nicht so laufen, oder? Wahrscheinlich haben Sie einen ganzen Haufen von Artikeln für die Wissensdatenbank geschrieben, als Sie Ihr Produkt zum ersten Mal herausbrachten.

Aber dann, drei Monate später, bringen Sie eine neue Funktion heraus. Jetzt müssen Sie den Eintrag in die Wissensdatenbank für diese neue Funktion schreiben und... dasmenschliche Gedächtnis ist nicht so gut. Es ist gut möglich, dass Sie am Ende etwas anders machen, auch wenn Sie es nicht beabsichtigen.

Ganz gleich, ob Sie allein oder in einem Team arbeiten, es lohnt sich, Ihren Leitfaden für die Wissensbasis zu Papier zu bringen.

Tun Unternehmen dies tatsächlich? Ist ein Knowledge Base Style Guide eine echte Sache?

Ok, ich werde Ihnen gleich sagen, wie Sie Ihren Styleguide erstellen. Doch zunächst möchte ich einige Beispiele von Unternehmen anführen, die dies tatsächlich tun. Damit werden zwei Ziele erreicht:

• Das zeigt Ihnen, dass ich mir nicht nur Dinge ausdenke, um mehr Blog-Inhalte zu erstellen 😉 .
• Es gibt Ihnen ein Beispiel aus dem wirklichen Leben, das Sie für Ihren eigenen Styleguide heranziehen können.

Schauen wir uns zuerst Mozilla an. Mozilla hat einen ganzen Eintrag über den Styleguide für seine Wissensdatenbank. Da Mozilla Open Source ist, ist es für sie besonders wichtig, einen Styleguide zu haben, um, in ihren eigenen Worten, "die Firefox-Support-Wissensdatenbank konsistent zu machen, was zu einer Wissensdatenbank führt, die leicht zu lesen ist und zu der man beitragen kann.". Leicht zu lesen? Das klingt nach einem guten Ziel für Ihre Wissensdatenbank, oder?

Der Leitfaden geht in die Tiefe und behandelt alles von der Groß- und Kleinschreibung über Leerzeichen bis hin zur Kommasetzung.

Als Nächstes ist MailChimp's Voice & Tone eine weitere lesenswerte Lektüre. Sie ist zwar nicht zu 100 % auf Wissensdatenbanken ausgerichtet, enthält aber eine Reihe von Einträgen für Wissensdatenbanken und Anleitungen:

Während Mozillas Styleguide eher auf Stil und Formatierung abzielt, konzentriert sich MailChimp eher auf, nun ja, Stimme und Tonfall, als auf die Feinheiten der Formatierung.

Wie Sie einen Style Guide für Ihre Wissensdatenbank erstellen

Ich habe Ihnen ein paar Beispiele gezeigt, aber ich muss Ihnen noch einen Prozess zur Erstellung Ihres eigenen Styleguides für die Wissensdatenbank vorstellen. Das sollten wir also ändern!

Verwenden Sie eine konsistente Person

Haben Sie schon einmal einen Artikel gelesen, in dem der Autor zwischen "ich" und "wir" hin und her wechselt? Ich schon, und wir können Ihnen sagen, dass das äußerst verwirrend ist.

Wenn Sie also die erste Person verwenden wollen, wählen Sie eine aus und seien Sie konsequent. Auch wenn Sie allein sind, können Sie sich für "wir" entscheiden. Es liegt an Ihnen! Verwenden Sie einfach dieselbe Person.

Außerdem müssen Sie nicht einmal die erste Person verwenden. Sie können auch ganz auf "ich" und "wir" verzichten.

Hier gibt es eigentlich keine richtige Antwort - es geht nur um Konsistenz.

Standardisieren Sie Ihre Formatierung

Wenn Sie unseren ultimativen Leitfaden für Wissensdatenbank-Artikelvorlagen gelesen haben, wissen Sie, dass gute Wissensdatenbanken viele Anweisungen mit kleinen Schritten enthalten. Und diese Anleitungen enthalten irgendwann Formulierungen wie:

Klicken Sie auf Datei.

Also - ist es:

• Klicken Sie auf Datei
• Klicken Sie auf "Datei".
• Klicken Sie auf Datei

Und wenn Sie Ihre Listen tatsächlich schreiben, ist es:

• Schritt 1: Klicken Sie hier
• Schritt 2: Klicken Sie auf das

Oder ist es so:

• Klicken Sie hier
• Das anklicken

Auch hier können Sie sich das aussuchen, was Ihnen am besten gefällt - aber welches auch immer Sie wählen, verwenden Sie es konsequent in Ihrer gesamten Wissensbasis.

Es gibt noch andere Formatierungsentscheidungen, die Sie treffen müssen - der Mozilla-Style-Guide gibt Ihnen einen guten Überblick über alles, was Sie beachten müssen, aber hier sind ein paar erste Ideen:

• Groß-/Kleinschreibung der Überschrift - verwenden Sie Groß-/Kleinschreibung im Satz oder im Titel?
• Zahlen - ist es 10 oder zehn?
• Abkürzungen - nicht oder nicht mehr?
• Akronyme - CDN oder Content Delivery Network?

Wenn Sie eines unserer wissensbasierten WordPress-Themes oder -Plugins verwenden, können unsere integrierten Shortcodes und Formatierungsoptionen Ihnen helfen, bei der Formatierung konsistent zu bleiben

Die Stimme richtig einsetzen

Schließlich müssen Sie über die Formatierung hinausgehen und Ihre Sprache standardisieren.

Sind Sie der Freund Ihres Kunden? Oder sind Sie Spock aus Star Trek, der leidenschaftslos kalte, harte Weisheiten verkündet?

In einem vernünftigen Rahmen ist beides in Ordnung. Solange es konsistent ist.

Im Allgemeinen sollten Sie sicherstellen, dass Sie die Tipps in der Wissensdatenbank von MailChimp befolgen. Ich empfehle sie nicht nur, weil MailChimp ihren Leitfaden tatsächlich veröffentlicht hat, sondern auch, weil ich denke, dass MailChimp eine der besten Wissensdatenbanken auf dem Markt hat.

Ihr Rat lautet folgendermaßen:

• Ihre oberste Priorität ist es, Fragen zu beantworten und Ihre Leser zu informieren. Witze sind manchmal in Ordnung, aber nicht, wenn sie von diesem wesentlichen Ziel ablenken.
• Vermeiden Sie es, wie ein Vermarkter zu sprechen - Sie versuchen nur zu helfen.

Wo bewahren Sie Ihren Style Guide auf?

Sie sollten diese Entscheidungen nicht nur treffen . Sie müssen sie auch tatsächlich an einem sicheren Ort aufschreiben.

Die meisten Styleguides, mit denen ich persönlich arbeite, sind Google Docs-Dokumente. Auf diese Weise können Sie Ihren Styleguide leicht gemeinsam nutzen und von verschiedenen Computern aus darauf zugreifen.

Wenn Sie aber eine andere Methode bevorzugen, können Sie das tun, womit Sie vertraut sind. Das einzig wirklich Wichtige ist dies:

Sie haben eine Kopie Ihres Styleguides für die Wissensdatenbank an einem sicheren Ort aufbewahrt, wo Sie oder andere darauf zugreifen können, wenn Sie eine Auffrischung der Formatierung Ihrer Wissensdatenbank benötigen.

Bringen Sie es also zu Papier und beginnen Sie mit der Erstellung konsistenterer Wissensbasisartikel!