内部ドキュメント：知っておくべきことすべて（ヒントとチュートリアル）

公開: 2022-07-04

あなたのビジネスには内部文書が必要ですか？そして、そもそも内部ドキュメントとは何ですか？

顧客が製品やサービスからより多くの価値を得るのに役立つドキュメントを作成するというアイデアはおそらくご存知でしょうが、高品質のドキュメントはビジネスや従業員の作業を改善するのにも役立ちます。

このタイプの内向きのドキュメントは内部ドキュメントと呼ばれ、生産性の向上、知識の保存と共有などに使用できます。

このガイドでは、以下を含む、内部ドキュメントについて知っておく必要のあるすべてのことを学びます。

内部ドキュメントとは
内部文書の利点
内部ドキュメントのベストプラクティス
独自の内部ドキュメントハブを作成する方法

内部ドキュメントとは何ですか？

内部ドキュメントは、会社の手順、知識、ベストプラクティスなどの構造化されたコレクションです。

あなたの会社の存続期間中、あなたの会社はたくさんの知識と専門知識を蓄積します。内部ドキュメントは、この集合的な知識のすべてを1つの簡単にアクセスできるハブに保存するのに役立ちます。

これを使用して、生産性の向上、知識の損失の防止、新入社員の採用などを行うことができます。

いくつかの重要な概念を分解してみましょう…

内部ドキュメントと外部ドキュメント

内部および外部のドキュメントはどちらも、プロセスのドキュメント化、処理方法の説明、重要な知識の共有などの同じ目標を果たします。

主な違いは、そのドキュメントの対象読者が誰であるかです。

内部文書–対象読者は会社の従業員です。
外部ドキュメント–対象読者は、ユーザー、顧客、クライアントなどです。

基本的に–顧客、または一般的に部外者は、あなたの内部文書を見るべきではありませんが、あなたの従業員は彼らの仕事を成し遂げるために内部文書に依存するでしょう。

さまざまな種類の内部ドキュメント

これについては少し上で触れましたが、さまざまな種類の内部ドキュメントがあり、それぞれを特定の目標に合わせて調整する必要があります。

プロセスの文書化–特定のタスクを適切に実行する方法を文書化する必要があります。これには、チェックリスト、チュートリアルなどが含まれる場合があります。たとえば、「新しい内部ドキュメントを作成する方法」に関する記事があるとします。
プロジェクトのドキュメント–各プロジェクトの詳細と進捗状況をドキュメント化する必要があります。これには、提案、ビジネスケース、会議の概要、タイムラインなどが含まれます。
ポリシー/HRドキュメント–従業員のオンボーディング、休暇ポリシー、病欠、従業員のオフボーディングなどの重要なポリシーを文書化する必要があります。
チームのドキュメント–各チームは、チーム固有の知識とポリシーに関する独自の内部ドキュメントを作成する場合があります。たとえば、コンテンツチームは、ゲストポスターを操作するためのブログスタイルガイドとポリシーを文書化する場合があります。
技術文書–開発チームがいる場合は、コード、スタイルガイド、QAテストポリシーなどで何が起こっているかを説明する独自の内部文書を作成する必要があります。

内部ドキュメントの利点：なぜそれは努力に値するのですか？

内部ドキュメントの作成には、間違いなく、「ただそれを手に入れる」よりも少し時間がかかります。

では、内部ドキュメントの利点は何ですか？つまり、内部ドキュメントの作成に時間と労力を費やす価値があるのはなぜですか？

内部ドキュメントの最大のメリットは次のとおりです。

知識の共有を促進する–従業員に知識の共有を促すことができます。さらに、従業員は、毎回元の共有者と直接対話する必要なしに、他の従業員が共有した知識に簡単にアクセスできます。
生産性の向上–重要なプロセスと詳細を文書化することで、従業員が不必要に行き詰まらないようにすることができ、全体的な生産性が向上します。
新しい従業員をより効率的に採用する–新しい従業員があなたの会社に加わるとき、彼らはあなたのプールされた内部知識に頼ってすぐにスピードを上げることができます。
知識を保持する–ある時点で、主要な従業員は、恒久的に、または休暇/病気のために退職します。内部ドキュメントを用意することで、従業員がいなくなった場合でも、それらの従業員の知識が保持され、アクセスできるようになります。

質の高い内部ドキュメントを作成するためのベストプラクティス

内部ドキュメントとは何か、なぜそれが重要なのかがわかったところで、実際に独自の内部ドキュメントハブを作成する方法にシフトしてみましょう。

まず、いくつかの一般的な内部ドキュメントのベストプラクティスから始め、次に、独自のハブを作成する技術的なプロセスについて説明します。

主要な利害関係者を関与させる–内部文書はトップダウンアプローチを使用するだけではありません–各レベルの主要な従業員を関与させることが重要です。結局のところ、これらの従業員は、多くの場合、あなたが保存したい「塹壕の中」の知識を持っている従業員です。また、明確な意思決定者がいるように、特定の従業員をコンテンツキュレーターとして任命することもできます。
既存のドキュメントを再利用する–おそらく既存のコンテンツがさまざまな場所に押し込まれているため、内部ドキュメント全体を最初から作成する必要はありません。そのコンテンツを1つの中央ハブに転用して、アクセスしやすくするようにしてください。
アクセスを簡単にする–アクセスのしやすさについて言えば、ハブを簡単に参照および検索できるようにする必要があります。インスタント検索の提案などのカテゴリと機能を使用して、従業員を関連するコンテンツに誘導します。
一貫性を保つためのスタイルガイドを作成します。すべてのドキュメントで異なるフォーマットが使用されている場合、人々が価値を得るのは困難になります。これを回避するには、事前にスタイルガイドを作成し、コンテンツごとにそれに従います。
画像、動画、GIFを含める–テキストだけに頼るのではなく–画像、動画、およびGIFなどの他のメディアを含めると、コンテンツがより便利になります。たとえば、特定のプロセスを文書化する場合、プロセスを文書化する画像またはビデオを含めることができます。
過剰な文書化を避ける–内部文書化には多くの利点がありますが、過剰な文書化はフラストレーションを引き起こし、従業員を苛立たせる可能性もあります。重要な詳細を文書化することと、忙しい仕事で従業員に負担をかけることとの間でバランスを取ることが重要です。
すべてを最新の状態に保ちます–プロセスと組織の知識は時間の経過とともに変化するため、これらの変化に対応するために内部ドキュメントを更新することが重要です。繰り返しになりますが、時間の経過とともに内部ドキュメントを更新する責任がある利害関係者として従業員を任命することが役立つ場合があります。
従業員からのフィードバックを求める–社内文書は従業員の生活を楽にするためにあることを忘れないでください。従業員はあなたの内部知識を向上させる方法についていくつかの素晴らしいアイデアを持っているかもしれないので、恐れずに従業員からのフィードバックを求めてください。

内部ドキュメントハブを作成する方法

最後の質問ですが、実際に、すべての従業員が内部のドキュメントリソースにアクセスできるハブをどのように作成しますか？

ナレッジベースソフトウェアに関しては、主に3つのオプションがあります。

WordPressやHeroThemesなどのオープンソースソフトウェアを使用します。
SaaSツールを使用します。
独自のソリューションをコーディングします。

少し偏見があるかもしれませんが、WordPressを使用したオープンソースアプローチは、いくつかの理由で非常に理にかなっていると思います。

ドキュメントの完全な所有権と管理権があります。ドキュメントには、（SaaSツールの場合のように）他人のサーバーに配置したくない機密情報が含まれている場合があります。 WordPressを使用すると、すべてのデータと情報を自分のサーバーに保存できます。
それはまだ非常に簡単です。 HeroicナレッジベースのようなWordPressプラグインを使用すると、ごく短時間で稼働できるようになります。これは、独自のソリューションを開発する場合には当てはまらない可能性があります。
費用対効果が高いです。 WordPressのアプローチは、一般的にSaaSツールよりもはるかに安価です。 1年間で償却されるため、無制限の記事と無制限のユーザーに対しては、通常、月額15ドル未満で支払うことになります。

WordPressとHeroicナレッジベースプラグインを使用して内部ドキュメントハブを作成する方法は次のとおりです。

1.WordPressインストールを設定します

開始するには、内部ナレッジハブとして機能する新しいWordPressインストールを作成する必要があります。

WordPressのインストールには2つのオプションがあります。

会社のローカルネットワークからのみアクセスできるイントラネットサイトを作成できます。 WordPressイントラネットサイトの設定に関するガイドがあります。
どこからでもアクセスできるパブリックWordPressサイトを作成できますが、パスワードや従業員のユーザーアカウントを使用してアクセスを制限します。ユーザーアカウントを作成したり、従業員と共有できる単一のパスワードでサイト全体を制限したりできるプラグインはたくさんあります。

最近のリモートワークの人気のため、従業員がオフィスにいないときでも内部ドキュメントにアクセスできるように、2番目のアプローチを採用することをお勧めします。

2.英雄的な知識ベースをインストールします

WordPressをインストールしたら、Heroicナレッジベースプラグインを追加して、内部のドキュメントハブに変えることができます。

Heroicナレッジベースは、WordPressに完全なナレッジベース機能を追加するWordPressプラグインです。内部ドキュメントハブを成功させるための多くの機能が含まれています。

関連するコンテンツに従業員を導くためのインスタント検索の提案。
トピック、部門などでコンテンツを整理するための無制限のカテゴリ。
従業員が記事に関するフィードバックを提供できるようにする組み込みのフィードバックツール。
WordPressの組み込みバージョン管理システムによる簡単なバージョン管理とリビジョン管理。これは、記事が時間の経過とともにどのように変化したかを確認する（および必要に応じて変更を元に戻す）のに最適です。
組み込みの分析により、従業員が最も関心を持っているコンテンツを確認できます。この情報を使用して、ドキュメントを改良および最適化できます。
ヘルプアシスタントウィジェットは、従業員が関連ドキュメントを見つけるためのもう1つの簡単な方法を提供します。

Heroicナレッジベースを購入すると、他のWordPressプラグインと同じようにインストールできます。次に、内部ドキュメントのナレッジベースに関するすべてを構成できる使いやすい設定領域が表示されます。

または、KnowAllテーマを使用することもできます。このテーマは、ドキュメントハブの設計を処理すると同時に、Heroicナレッジベースプラグインのすべての機能を組み込みます。

3.ドキュメント記事を追加します

Heroicナレッジベースプラグインをインストールすると、内部コンテンツの追加を開始する準備が整います。

Heroicナレッジベースでは、柔軟なWordPressブロックエディターを使用してこれを行うことができます。

Heroic Knowledge Baseには、ドキュメントの強化に役立つ専用のブロックもいくつか追加されています。たとえば、コールアウトや警告を簡単に追加して、回避すべき重要な情報や問題を強調することができます。

無制限のカテゴリを追加して、コンテンツを整理することもできます。

記事やカテゴリの順序を変更するために、特別なドラッグアンドドロップインターフェイスを利用できます。これらにアクセスするには、 HeroicKB→ArticleOrderingまたはHeroicKB→CategoryOrderingに移動します。

今すぐ社内ナレッジベースを作成する

内部ドキュメントの作成には、コンテンツの作成に時間を費やすというコミットメントが必要ですが、知識を保持および共有し、生産性を向上させ、新入社員をより効率的に採用できるようになると、その投資は報われます。

内部ドキュメントハブをセットアップする最も簡単な方法として、オープンソースのWordPressソフトウェアとHeroicナレッジベースプラグインを使用できます。

WordPressとHeroicナレッジベースを使用すると、次のメリットが得られます。

すべてがサーバー上にあるため、会社のデータの完全な所有権と制御。
無制限の使用に対して1つの低いフラットコストを支払うため、コストが低くなります。
Heroicナレッジベースは必要なすべての機能を提供するためシンプルであり、カスタムソリューションを最初からコーディングする必要がありません。

今すぐ社内コンテンツハブをセットアップすれば、すぐにメリットが得られます。