Close

指針となるドキュメント標準

これらのベスト プラクティスでドキュメントの泥沼を管理する

どのような作業を行うにしても、全メンバーに情報を知らせて効率性を高め、明確にコミュニケーションをとることができるように、チームには明確で最新の内部向けドキュメントが必要です。機能するドキュメントを入手する最良の方法は、ドキュメント標準を作成することです。これらは、チームまたは組織内でドキュメントの作成および配布を導くルールです。

ドキュメント標準を使用すると、ドキュメントの作成方法、作成したドキュメントの配布方法、そして最も重要な点として、必要なドキュメントのある場所についてチーム全員が認識を共有できます。

虫眼鏡とチケットでフォルダーを開く

チームのドキュメント標準を開発する中で、特定の種類のドキュメントに使用するフォーマットは? ドキュメントをどこに保管するか? など、多くの疑問が出てくるかもしれません。このガイドは、これらの質問に答える際に幸先の良いスタートを提供します。

ドキュメントとテンプレートの種類

従う標準は、作成しているドキュメントの種類によって異なります。ここでは、一般的な種類と、標準を作成する際に使用できるテンプレートに関する提案をいくつかご紹介します。

プロジェクトドキュメント

全員が認識を共有していると、プロジェクトはよりスムーズに行われます。プロジェクトのすべてのチーム メンバーには、いつでも参照できる信頼できる唯一の情報源が必要です。プロジェクト計画がドキュメント化されていないと、チーム メンバーは全体像を見失って時間を無駄にする可能性があります。

プロジェクトのドキュメントを高速化および標準化するために、この Confluence によるテンプレートを使用できます。これにより、あらゆるプロジェクトに関する主要な情報を一貫して取得できます。

文書化する方法

常に他の人に物事を行う方法を説明しなければならないため、チーム メンバーは時間を浪費していますか?または、重要なタスクやプロセスを行う方法を知る人がオフィスにいなかった際に、取り乱したことはありませんか?

これらのシナリオは、ハウツー ドキュメントの重要性を指しています。基本的に、チーム メンバーが繰り返し行うことは、チームの誰かがそのタスクまたはプロセスを完了できるような方法でドキュメント化する必要があります

標準を作成すると、ハウツー ドキュメントは作成しやすくなることは言うまでもなくより効果的に作成できます。繰り返しますが、ここでテンプレートが役に立ちます。たとえば、Confluence のハウツー記事テンプレートは、ドキュメント プロセスの手法を説明します。

技術およびソフトウェア ドキュメント

ソフトウェアやその他の技術製品のドキュメントは、製品の仕組み、使用方法、作成方法、まとめ方などを説明できます。

ソフトウェア チームであれば、製品の要件、リリースノート、設計仕様について話し合うときにドキュメントを参照することもあるでしょう。技術チームであれば、コードや API について詳しく解説してソフトウェア開発プロセスを記録するのに、ドキュメントを使用するかもしれません。

技術ドキュメントは長く詳細になって頻繁に更新される傾向があるため、正確性を確保して時間を節約するために適切なツールを用意することが特に重要です。たとえば、既存の Confluence のテンプレートを使用したり独自のテンプレートを作成したりできます。Confluence には、テキストの更新や再利用を容易にするマクロもあります

必要な主要ドキュメント スキル

作成しているドキュメントの種類に関係なく、作業がドキュメント標準を満たしてユーザーに役立つ重要なスキルがいくつかあります。

  • 組織。1 つはドキュメント化したい情報を知ることです。わかりやすくそれを提示することとは、まったく別です。情報を論理的な順序で整理するだけでなく、セクションのヘッダーや箇条書きなどの要素を使用してドキュメントのユーザーを導くことも重要です。
  • 明確性。明確でわかりやすいドキュメントを作成するには、適切な詳細レベルを選択する必要があります。情報が少なすぎると混乱しますが、多すぎても混乱します。ドキュメントの明確性を向上させる他の方法としては、文法に細心の注意を払っていること、専門用語を避けること、(「頻繁に」など) 曖昧な単語よりも具体的な言葉を選択することがあります。
  • 一貫性。一貫性に注意を払うことは、ドキュメントを使用しているすべての人にとって最も役立つことの 1 つです。たとえば、組織内の他のハウツー ドキュメントと同じ方法で記述されている場合、ユーザーはハウツー ドキュメントを楽にフォローできます。

ドキュメントの配布方法

標準を作成することはより良い文書の作成に役立つだけではなく、ドキュメントをより効果的に配布するのにも役立ちます。

ドキュメントが役に立つようにするには、チーム全体がドキュメントにアクセスできる必要があります。チーム メンバー各自のハード ドライブに重要な情報を保持してもらいたくありません。また、無作為なファイリング キャビネットに隠された単一の印刷コピーに頼る必要はないでしょう。このような状況は、混乱と非効率につながります。

たとえば、異なるバージョンのドキュメントを使用しているチーム メンバーは、誤解が生じたり、誤って互いに余分な作業を作成したりする可能性があります。または、リモートで作業しているユーザーは、オフィスに物理的にのみ存在するドキュメントにアクセスしなければならない場合があります。

ドキュメントの保存方法と配布方法を標準化することで、これらの問題を回避できます。一元化されたリポジトリを備えることが最も効果的です。誰もが知っている単一の場所で、最新の情報を探せます。しかし、ただすべてのものを一箇所に配置するだけでなく、そこにたどり着いたときに簡単に探しているものを見つけられるようにしておく必要もあります。

Atlassian では、一元化されたリポジトリは Confluence です。強力な検索、ページのツリー構造、ページのアーカイブなどの機能により、コンテンツを簡単に見つけて最新の状態で手元に置いておけます。

Confluence では、すべてのチームやプロジェクトには、関連するドキュメントを整理するためのスペースがあります。チームやプロジェクトは、ページの階層を作成してすべての情報を整理し、ページ ツリーから表示できるようにします。従業員は、コンテンツが変更されたときに更新するために、関心のあるスペースやサブページを見れます。特定のスペースまたはページを配布するには、ページ上で共有ボタンまたはコメントを使用し、他のチーム メンバーにタグを付けます。Confluence で開いているすべてのページは、他の従業員が検索でき、フィルターを使用して作成者、公開日、スペース別に検索範囲を絞り込めます。

個々のドキュメントに一貫したアップデートが必要であるように、ドキュメントをファイリングして整理するシステムにもアップデートが必要です。したがって、ここでも忘れずに自分の標準を作成してください。どのくらいの頻度でドキュメントのファイリングを再確認して整理する必要がありますか?カレンダーでその時間を確保しておきましょう。

チームのドキュメント標準の設定

ドキュメント標準の概要を確認したら、チームが必要とするドキュメントの種類に応じたガイドラインの作成または改訂を開始できます。これらの標準の設定に投資する時間は、ドキュメント作成時間を短縮して、チームにとってそのドキュメントを便利なものにするのに役立ちます。

以下も参照してください

マスタープロジェクトドキュメントテンプレート

信頼できる単一の情報ソースを利用して、全員で最新情報を共有できます。

Confluence テンプレート

製品要件からマーケティング計画まで、すべてを Confluence で作成できます

次の記事
Importance of Documentation