内部向けドキュメントで満点を取る方法

内部向けドキュメントとは、社内のチーム メンバーが参照できるように、明確かつ詳細なプロセスと手順を作成して維持することです。

これは外部向けドキュメントとは異なります。たとえば、顧客に提供するマニュアルなど、(その名前が示すように) 組織外のユーザーが使用するものではありません。

内部向けドキュメントは開発や IT に関していろいろ言及しているため、多少混乱を招く可能性があることは隠すまでもありません。チームは、作成するソフトウェアとアプリケーションのコードを慎重にドキュメント化する必要があります。

しかしドキュメントは若干技術的な基盤があるものの、人事からカスタマー サポート チームまで全社的に役立つプラクティスです。

この記事で説明する内容のほとんどは、プロセス ドキュメントに関するものです。このドキュメントは、チーム メンバーが担当するタスクやルーチンの手順を記録します。

しかし、それは明らかに内部向けドキュメントの唯一のタイプではありません。その他の一般的なタイプは次のとおりです。

• チーム ドキュメント: チームによって行われている作業に関連する情報です。目標、プロジェクト計画、チームのスケジュール、進捗レポート、会議メモなどを考えてみてください。
• 参照ドキュメント: プロセス ドキュメントは、このより広範なバケットに分類されます。参照ドキュメントは、重要なトピック、プロセス、ポリシー (休暇の申請方法など) を伝えます。
• プロジェクト ドキュメント: このタイプのドキュメントは、特定のプロジェクトに固有のものです。これには、提案、製品要件、設計ガイドライン、スケッチ、ロードマップなどを含められます。

この記事では、主に参照ドキュメント (特に、プロセス ドキュメント) に焦点を当てます。しかし、それら他のタイプを把握することも、用意しておくと便利なコンテキストです。

あまりに多くの企業が、(危機的状況が近づいてあたふたした状態になるまで) 内部向けドキュメントの影響を認識できないでいます。実際、BpTrends の調査によると、常にプロセスをドキュメント化している企業は 4% に留まるそうです。50% はときどきドキュメント化していると認めています。

もう少し自説を主張させてください。つまり、その統計結果の一部にならないでください。内部向けドキュメントは、多数のさまざまな理由で本当に重要です。

あなたは、毎月の要約をクライアントに送信する同僚の義務を引き継いでいるとします。すべて自分でごそごそ探し回れば早くなるのでしょうか? あるいは、その情報をプルして配布する方法を正確に教える詳細な指示とスクリーンショットに従えば、さらにスピード アップできるでしょうか?

後者が正解なのは言うまでもありません。

内部向けドキュメントは、経費精算書への記入やクライアントとの会議のスケジュールなど、タスクを効率的に実行するためにチーム メンバーが頼れる共通プロセスのリソースの役割を果たします。それは、山のような推測作業で進捗を一時停止させるよりは、(ストレスが少ないのは言うまでもなく) はるかに優れています。

Gallup の調査結果では、従業員の 12% のみが、組織は新しい従業員の研修プログラムでよくやっていると強く賛同していることがわかりました。

新しい仕事を始めて自分の面倒を見なければならないと感じるよりも深刻なことはほとんどないため、もどかしいものです。

強力な内部向けドキュメントのプラクティスにより、新しいチーム メンバーは新しいロールのさまざまな側面に自信を持って取り組む際に、頼れる豊富な知識の持ち主になります。

もちろん、ドキュメントはその脆弱な研修プログラム期間中の教育や個人的な付き合いなどの代わりにはなりません。しかしながら補足として確かに役立ち、すぐに新しいチーム メンバーに多少の自律性と独立性を与える素晴らしい方法であります。

重要な情報と専門知識はあまりにも頻繁に、他と連携しないまま個々のチーム メンバーの脳内に格納されています。そうなると、特にある調査で回答者の 42% が、仕事に必要な知識は一回々々の案件に固有であるという認識を持っているため、当事者が去るときには大きな問題に目を向けることになります。

だからこそ、この当事者の知識を彼らの脳内から取り出してドキュメント化することは当たり前なのです。これによってこれらのサイロが解消されてナレッジ共有が促進され、チームは不測の事態やリソース不在においてもはるかに簡単に勝ち抜けるのです。

理由がわかったら、そのやり方を見てみましょう。

これらのベスト プラクティスに従って、さらにチームをイライラさせるのではなく、実際にチームに役立つ内部向けドキュメントを作成します。

調べるのに辞書が必要だと感じたら、誰もあなたのドキュメントに目を通しません。簡単に言って、専門用語、頭字語、複雑な言葉の使いすぎを避けてください。また、セクション ヘッダーと箇条書きをふんだんに使って、圧倒的ではないざっと読めるドキュメントにします。

例やビジュアルほど明確さを与えるものはありません。そのため、テキストだけに頼るのではなく、それらを組み込むようにします。恒例の昼食会の招待を差し込み印刷する方法を説明するのではなく、前回の時のスクリーンショットを使用してそのプロセスを説明します。

人に使ってもらいたいのなら、まず見つけられなければなりません。内部向けドキュメントは多数のフォルダーに埋没させず、アクセスできるようにしてください。それは Confluence の特典の 1 つです。Confluence では、オープンなページ ツリー構造を採用しています。無限にあるフォルダーの階層の中でもドキュメントを見失いません。ファイルに名前を付けるとき、チームメイトがどんな用語でそれらの指示を見つけようとするかを考えてみてください。平易で簡単な言い回しによって、必要なものを見つける手順がはるかに簡単になります。

プロセスを詳しく知っている場合に、手順をスキップして重要な詳細情報を適当にごまかすのは簡単です。疑わしい場合は、じっくり詳細を説明することに時間を割きましょう。次にセルフチェックとして、プロセスに慣れていないユーザーにドキュメントを確認して、そのドキュメントをフォローできるかどうかを確認します。ユーザーが途中で立ち止まったら、その場所に焦点を合わせてその部分をどのようにより明確にできるかを考えてみます。

上記のヒントで手がかりが得られない場合は、内部向けドキュメントを自分で処理する必要はありません。チーム メンバーを呼んで会社の頭脳をページにダウンロードし、彼ら自身の一般的プロセスをいくつかドキュメント化するように依頼します。結局、彼らこそ、そのタスクに最も精通している人なのです。

会社とチーム内の物事はすばやく変化します。物事を書き留めた、しかしそれで盤石というわけではありません。プロセスが変更されたとき (新しいソフトウェアを使用している場合やいくつかの手順を簡略化した場合など) に何が何でもやりたいことは、PDF やその他の静的リソースをやり直したり微調整したりすることです。生きたドキュメント (ちなみに Confluence がこれに最適です) を使用すると、チーム同様、内部向けドキュメントが進化しやすくなります。さらに付け加えるなら、チーム メンバーがはるかに貢献しやすくなります。

洗練された内部向けドキュメント化プロセス (テンプレート付き) を使用すると、ドキュメント作成作業が大幅に減って全社での一貫性が向上します。プロセスを作成するためのプロセスがあります。そこで Atlassian の出番です。以下の手順を実行します。

Atlassian はドキュメント作成を熱烈に支持しますが、それは絶対にすべてが慎重かつ詳細に記録すべきものであるということを意味するものではありません。1 回限りのイベントやランダム イベントの手順に過剰なエンジニアリングは不要です。

どのようなものをドキュメント化するかについて、いくつかの基本ルールを設定することから始めます。プロセスが一定回数 (3 回など) 発生しなければ、ドキュメント化に値しないと判断しますか?プロセスは頻繁に (少なくとも月に 1 回など) 行う必要がありますか?

すべてをドキュメント化しようと計画するのは少し野心的であり、その後もがき苦しむことになります。だからこそ、ドキュメント化する価値があるものについていくつか基準を作成するのが賢いやり方なのです。

誰もが使えるテンプレートを作成することで、時間を節約してドキュメントの一貫性を確保できます。テンプレートに次のフィールドを含めるようにします。

• このプロセスが存在する理由の簡単な説明
• このプロセスの主要プレイヤー
• プロセスを完了するために必要なもの (ソフトウェアや消耗品など)

これらのフィールドにより、誰もがその文書をするために必要な情報を簡単に得られます。

ドキュメントを使用する場合は、ドキュメントにアクセスできる必要があることを覚えておいてください。まだ作成していない場合は、これらの記録を保存できるフォルダーまたはハブを作成します。

必要なものを苦労して見つけ出す必要がないように、使うものは何でも簡単に検索可能にするのが理想的です。

洗練されたドキュメント化プロセスがあっても、物事は乱雑になる場合があります。ドキュメントは最後に間違った場所に置かれて、手順を更新する必要があります。

毎月または四半期ごとに時間を確保して、プロセスを微調整したりファイルを整理したりするなど、すべてのドキュメントを調べて片付けます。これによりシステムを申し分ない状態に保てるため、使用される可能性が高くなります。

このガイドで、内部向けドキュメントのプロセスを作成する方法について、核心部分の詳細をご確認ください。

内部向けドキュメントをまとめることに関しては、チームは大きな助けになるだけではなくテクノロジーが介入することで簡単にもできます。個々のデスクトップに保存されるファイル システムではなく、内部向けドキュメント ソフトウェアを選択できます。ソフトウェアでは、ページの共同編集、インライン コメントやページ コメントを使用したフィードバックの収集、他のチーム メンバーの入力のタグ付けが可能になるため、こうすることでシームレスに貢献できるようになります。

またソフトウェアでは、専用のスペースと高度な検索機能にグループ化された関連ページを持つ体系的なナレッジ ハブを作成できます。その結果、チーム全体が信頼できる体系的なリソースになります。

大いに役立つと思いますか? 私たちはそう思いました。Confluence を確認して、一貫性を確保してストレスを軽減する内部向けドキュメントの作成を開始してください。

不要な手続きとして内部向けドキュメントを書き上げたくなります。しかし、もう一度自分に聞いてみてください。スター級の優れた従業員が今日辞表を提出したらどうなるでしょうか?どれくらい貴重な知識と経験が失われるでしょうか?

堅実なドキュメント プラクティスをいくらか実装することで、あなたとチームは楽観主義と自信を持って、これらの予期しない状況に取り組む準備ができます。