Organisieren Sie sich! So erstellen Sie einen Styleguide für Wissensdatenbanken

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:

• Mit dem richtigen Ton
• Konsequent alles gleich formatieren

Was aus Gründen, die ich im nächsten Abschnitt erläutern werde, tatsächlich überraschend schwierig ist. Hier kommt ein Wissensdatenbank-Styleguide ins Spiel.

Warum Ihre Wissensdatenbank ein Durcheinander verschiedener Stile sein könnte

Machen Sie sich keine allzu großen Sorgen, wenn Ihre Wissensdatenbank ein Durcheinander verschiedener Stile ist. Es passiert einer Menge Unternehmen, normalerweise aus einem von zwei Gründen (oder manchmal aus beiden!).

Erstens, wenn Sie Teil eines Teams sind, haben Sie möglicherweise verschiedene Personen, die Supportdokumente schreiben. Also wenn:

• Jim schreibt Artikel A
• Sally schreibt Artikel B

Diese Artikel werden wahrscheinlich sehr unterschiedliche Stile und Formatierungen haben … es sei denn, Sie haben einen vordefinierten Styleguide.

Wenn Sie jetzt nicht Teil eines Teams sind, sagen Sie wahrscheinlich: „Ich bin ein einsamer Wolf – ich schreibe alles selbst. Ich muss also nichts zu Papier bringen – das bin ich!“

Und das könnte der Fall sein … wenn Sie alle Ihre Knowledge-Base-Artikel in einer Sitzung geschrieben haben.

Aber wir wissen beide, dass die Dinge normalerweise nicht so laufen, oder? Sie haben wahrscheinlich einen Haufen Artikel in der Wissensdatenbank geschrieben, als Sie Ihr Produkt zum ersten Mal herausgebracht haben.

Aber dann, drei Monate später, veröffentlichen Sie eine neue Funktion. Jetzt müssen Sie den Knowledge-Base-Eintrag für diese neue Funktion schreiben und … menschliche Erinnerungen sind nicht so gut . Es besteht eine gute Chance, dass Sie am Ende etwas anders machen, auch wenn Sie es nicht versuchen.

Egal, ob Sie alleine oder Teil eines Teams sind, es zahlt sich aus, Ihren Wissensdatenbank-Styleguide zu Papier zu bringen.

Machen Unternehmen das wirklich? Ist ein Wissensdatenbank-Styleguide eine echte Sache?

Ok, ich werde Ihnen gleich sagen, wie Sie Ihren Styleguide erstellen. Aber zuerst möchte ich mit einigen Beispielen von Unternehmen vorangehen, die dies tatsächlich tun. Damit werden zwei Ziele erreicht:

• Es zeigt Ihnen, dass ich nicht nur Dinge erfinde, um mehr Blog-Inhalte zu erstellen
• Es gibt Ihnen ein reales Beispiel, aus dem Sie Ihren eigenen Styleguide ziehen können.

Schauen wir uns zuerst Mozilla an. Mozilla hat einen ganzen Eintrag im 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 tief und führt Sie durch alles, von der Großschreibung über Leerzeichen bis hin zu seriellen Kommas.

Als nächstes ist Voice & Tone von MailChimp eine weitere lohnenswerte Lektüre. Obwohl es sich nicht zu 100 % auf Wissensdatenbanken konzentriert, enthält es eine Reihe von Einträgen sowohl für Wissensdatenbanken als auch für Tutorial-Inhalte:

Während sich der Styleguide von Mozilla mehr auf Stil und Formatierung konzentriert, entscheidet sich MailChimp dafür, sich mehr auf, nun ja, Stimme und Ton zu konzentrieren, als auf die grundlegende Formatierung.

So erstellen Sie einen Styleguide für Ihre Wissensdatenbank

Ich habe Ihnen ein paar Beispiele zugeworfen, aber ich muss Ihnen noch einen Prozess für die Erstellung Ihres eigenen Styleguides für die Wissensdatenbank geben. Also lasst uns das beheben!

Verwenden Sie eine konsistente Person

Haben Sie schon einmal einen Artikel gelesen, bei dem der Autor zwischen „Ich“ und „Wir“ hin und her gewechselt hat? Ich habe, und wir können Ihnen sagen, dass es äußerst verwirrend ist.

Wenn Sie also die erste Person verwenden, wählen Sie eine aus und bleiben Sie dabei konsequent. Auch wenn Sie alleine sind, können Sie sich immer noch dafür entscheiden, „wir“ zu verwenden. Wie du willst! Verwenden Sie einfach das gleiche.

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

Hier gibt es nicht wirklich eine richtige Antwort – es geht nur um Konsistenz.

Standardisieren Sie Ihre Formatierung

Wenn Sie unseren ultimativen Artikelvorlagen-Leitfaden für Wissensdatenbanken lesen, wissen Sie, dass gute Wissensdatenbanken viele Anweisungen mit kleinen Schritten verwenden. Und diese Anweisungen werden irgendwann Sprache enthalten wie:

Klicken Sie auf Datei .

So 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 darauf
• Schritt 2: Klicken Sie darauf

Oder ist es so:

• Klicke hier
• Klicken Sie darauf

Auch hier können Sie diejenige auswählen, die Ihnen am besten gefällt – aber welche Sie auch wählen, verwenden Sie sie konsequent in Ihrer gesamten Wissensdatenbank.

Es gibt auch andere Formatierungsentscheidungen, die Sie treffen müssen – der Mozilla Style Guide gibt Ihnen eine gute Vorstellung von allem, was behandelt werden muss, aber hier sind einige Ideen für den Anfang:

• Großschreibung von Überschriften – werden Sie Groß- oder Kleinschreibung verwenden?
• Zahlen – ist es 10 oder zehn?
• Abkürzungen – nicht oder nicht?
• Akronyme – CDN oder Content Delivery Network?

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

Holen Sie sich die richtige Stimme

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

Sind Sie der Freund Ihres Kunden? Oder sind Sie Spock von Star Trek, der leidenschaftslos kalte, harte Weisheit verbreitet?

Im Rahmen des Zumutbaren ist beides in Ordnung. Solange es stimmig ist.

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

Ihr Rat lautet:

• Beantworten Sie immer zuerst Fragen und informieren Sie Ihre Leser. Witze sind manchmal ok, aber nicht, wenn sie von diesem wesentlichen Ziel ablenken.
• Vermeiden Sie es, wie ein Vermarkter zu sprechen – Sie versuchen nur zu helfen.

Wo speichern Sie Ihren Styleguide?

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

Persönlich sind die meisten Styleguides, mit denen ich arbeite, Google Docs-Dokumente. Auf diese Weise können Sie Ihren Styleguide ganz einfach teilen und von verschiedenen Computern aus darauf zugreifen.

Wenn Sie jedoch eine andere Methode bevorzugen, verwenden Sie das, was Ihnen vertraut ist. Das einzig wirklich wichtige ist:

Sie haben eine Kopie Ihres Wissensdatenbank-Styleguides an einem sicheren Ort gespeichert, wo Sie oder andere darauf zugreifen können, wenn Sie eine Auffrischung zum Formatieren Ihrer Wissensdatenbank benötigen.

Bringen Sie es also zu Papier und beginnen Sie mit der Erstellung konsistenterer Artikel in der Wissensdatenbank!