組織する！ ナレッジベーススタイルガイドの作成方法
公開: 2017-05-03知識ベースを書くことはすでに十分に難しいです。 ですから、この投稿でこれからやろうとしていることをお詫びします。 知識ベースのアイデアだけでなく、それらをどのように提示するかについても説明します。
これらのアイデアを超えて、常に次のことを確認する必要があります。
- 適切なトーンを使用する
- すべてを一貫して同じようにフォーマットする
これは、次のセクションで説明する理由から、実際には驚くほど難しいものです。 そこで、ナレッジベーススタイルガイドが役立ちます。
ナレッジベースがさまざまなスタイルの混乱になる理由
知識ベースがさまざまなスタイルの寄せ集めである場合でも、あまり心配する必要はありません。 これは多くの企業で発生しますが、通常は2つの理由のいずれか（または場合によっては両方）が原因です。
まず、チームの一員である場合は、さまざまな人がサポートドキュメントを作成している可能性があります。 したがって、次の場合：
- ジムは記事Aを書いています
- サリーは記事Bを書いています
事前定義されたスタイルガイドが用意されていない限り、これらの記事のスタイルとフォーマットは大きく異なる可能性があります。
さて、あなたがチームの一員でないなら、あなたはおそらく「私は孤独なオオカミです。私はすべてを自分で書いています。 だから私は紙に何も置く必要はありません-それは私だけです！」
そして、それは事実かもしれません…あなたが一度にすべての知識ベースの記事を書いたなら。
しかし、私たち二人はそれが通常のやり方ではないことを知っていますよね？ 製品を最初にリリースしたときに、知識ベースの記事をたくさん書いたと思います。
しかし、その後3か月後に、新しい機能をリリースします。 今、あなたはその新機能のための知識ベースエントリを書かなければなりません、そして…人間の記憶はそれほど良くありません。 やろうとしていない場合でも、別のことをしてしまう可能性は十分にあります。
したがって、ソロであろうとチームの一員であろうと、知識ベースのスタイルガイドを紙に書き留めておくことは有益です。
企業は実際にこれを行っていますか？ ナレッジベーススタイルガイドは本物ですか？
わかりました。すぐにスタイルガイドを作成する方法を説明します。 しかし、最初に、実際にこれを行っている企業の例をいくつか紹介したいと思います。 これにより、次の2つの目標が達成されます。
- それは私がより多くのブログコンテンツを作成するために物事を作っているだけではないことをあなたに示しています
- それはあなたがあなた自身のスタイルガイドのために引き出すことができる実際の例をあなたに与えます。
まずMozillaを見てみましょう。 Mozillaには、ナレッジベースのスタイルガイドに関するエントリ全体があります。 Mozillaはオープンソースであるため、「Firefoxがナレッジベースをサポートする一貫性を保ち、読みやすく貢献しやすいナレッジベースを作成する」ためのスタイルガイドを用意することが特に重要です。 読みやすい？ それはあなたの知識ベースにとって良い目標のように聞こえますよね？
ガイドは、キャピタライゼーションから空白、シリアルコンマに至るまで、すべてを詳しく説明しています。
次は、MailChimpのVoice＆Toneも読む価値があります。 ナレッジベースに100％焦点を当てているわけではありませんが、ナレッジベースとチュートリアルコンテンツの両方に多数のエントリがあります。
Mozillaのスタイルガイドはスタイルとフォーマットに重点を置いていますが、MailChimpは、本質的なフォーマットよりも、音声とトーンに重点を置いています。
ナレッジベースのスタイルガイドを作成する方法
私はあなたにいくつかの例を投げましたが、実際にあなた自身の知識ベーススタイルガイドを作成するためのプロセスをあなたにまだ与えていません。 だからそれを修正しましょう！
一貫性のある人を使用する
著者が「私」と「私たち」を行ったり来たりした記事を読んだことがありますか？ 私は持っています、そしてそれは非常に混乱しているとあなたに言うことができます。
したがって、一人称を使用する場合は、1人を選び、一貫性を保ちます。 ソロの場合でも、「私たち」を使用することを選択できます。 君による！ 同じものを使用してください。
さらに、一人称を使用する必要もありません。 「私」と「私たち」を完全に避けることを選ぶことができます。
ここには本当に正しい答えはありません–それは一貫性についてです。
フォーマットを標準化する
究極のナレッジベース記事テンプレートガイドを読むと、優れたナレッジベースが小さなステップで多くの指示を使用していることがわかります。 そして、それらの指示には、ある時点で、次のような言語が含まれます。
[ファイル]をクリックします。
だから–それは：
- ファイルをクリックします
- 「ファイル」をクリックします
- ファイルをクリックします
そして、あなたが実際にあなたのリストを書くとき、それはそれですか？
- ステップ1：これをクリックします
- ステップ2：それをクリックします
またはそれはこのようなものですか：
- こちらをクリック
- それをクリックしてください
繰り返しになりますが、最も気に入ったものを選択できますが、どちらを選択しても、ナレッジベース全体で一貫して使用できます。
あなたがする必要がある他のフォーマットの選択もあります– Mozillaスタイルガイドはあなたにカバーするすべての良いアイデアを与えます、しかしここにいくつかの最初のアイデアがあります：
- 見出しの大文字化–センテンスケースとタイトルケースのどちらを使用しますか？
- 数字–それは10または10ですか？
- 略語–しないか、しないか？
- 頭字語– CDNまたはコンテンツ配信ネットワーク？
ナレッジベースのWordPressテーマまたはプラグインのいずれかを使用している場合は、組み込みのショートコードとフォーマットオプションを使用すると、フォーマットに関して一貫性を保つことができます。
声を正しくする
最後に、フォーマットを超えて、音声を標準化する必要があります。
あなたはあなたの顧客の友達ですか？ それとも、スタートレックのスポックで、冷酷な知恵を冷静に分配していますか？
当然のことながら、どちらでも構いません。 それが一貫している限り。
一般に、MailChimpのナレッジベースガイドのヒントに必ず従ってください。 MailChimpが実際にガイドを公開しただけでなく、MailChimpには最高の知識ベースの1つがあると思うので、それらを提案します。
彼らのアドバイスはこれです：
- 質問に答え、読者に知らせることを常に最優先します。 ジョークは時々大丈夫ですが、彼らがその本質的な目標から気をそらす場合はそうではありません。
- マーケティング担当者のように話すことは避けてください。あなたはただ助けようとしているだけです。
スタイルガイドはどこに保存しますか？
これらの決定をするだけではいけません。 また、実際には、安全な場所に書き留めておく必要があります。
個人的には、私が使用しているスタイルガイドのほとんどはGoogleドキュメントのドキュメントです。 そうすれば、スタイルガイドを簡単に共有して、さまざまなコンピューターからアクセスできます。
ただし、別の方法を好む場合は、使い慣れた方法を使用してください。 唯一の本当に重要なことはこれです：
ナレッジベースのフォーマット方法の復習が必要な場合に、自分や他の人がアクセスできる安全な場所に、ナレッジベーススタイルガイドのコピーが保存されています。
だから、それを紙に書き留めて、より一貫性のある知識ベースの記事を作成し始めてください！