チームハンドブックは、文書が存在することを示すだけでなく、誰かが作業を完了できるよう助けるものであるべきです。繰り返し行う手順を一つ選び、社内用語をまだ覚えていない読者を想定するところから始めます。
無害な例を選びます：ワークショップのセッション用に承認済みファイルを準備する作業です。目標は明確に識別できるパッケージであり、会社が行っていることすべての説明ではありません。
ページの役割を定める
誰がそのページを使うのか、始める前に何が必要か、目に見える結果は何かを書きます。密接に関連する作業をまとめて説明する必要がある場合を除き、そのページには一つの手順だけを載せます。
次の構成を使います：
目的：承認済みのワークショップ資料を準備する。開始前：作業中のフォルダーへのアクセスとセッション識別子。作業：ファイルを見つけ、点検し、まとめ、引き渡す。完了：受け取る人が正しいパッケージを識別できる。担当者：この手順の変更を承認する人。
暗黙の知識を説明する
経験のある同僚にしか分からない用語に注意します。「いつものファイルを使う」と書くのではなく、実際の場所や判断のルールを明記します。ある手順に許可が必要な場合は、誰が許可を出せるかを説明します。
スクリーンショットは、ソフトウェアのバージョンと確認日に結び付けておきます。画像は、読者が見分ける必要のあるものを示す場合に役立ちますが、作業の説明の代わりにはなりません。
更新の責任を明確にする
ページに担当者、承認状態、見直しのきっかけを設定します。ツールが変わったときや、業務のプロセスが変わったときには、手順の確認が必要になることがあります。新しいバージョンが何を置き換えるのかを記録します。
ページに未解決の質問がある場合は、それが見て分かるように示します。ハンドブックを整然と見せるためだけに、下書きを承認済みのように見せてはいけません。
新人による演習を試す
その作業に不慣れな人にページを渡し、安全な例のファイルで作業してもらいます。隠れた手順の一つひとつを手取り足取り教えないでください。どこでためらったか、質問したか、間違ったファイルを選んだかを記録します。
そうした観察を使って説明を改善し、影響を受けた部分を繰り返します。ハンドブックは、こうした確認と保守を通じて役に立つものになります。会社のすべての知識がAIによって自動的に検索され、最新の状態に保たれていると主張する必要はありません。
Mika は、ハンブルクにある KENJTEC 編集チームが使用する編集用ペンネームです。この記事はワークフローを提案するものであり、完了したテストを報告するものではありません。
