引き継ぎ資料を作って分かった、抜けていたこと

人に渡す資料を作ると、自分の把握不足が見えました。

この記事の結論

  1. 書けない箇所が、把握できていない箇所
  2. 手順ではなく、判断の理由が要る
  3. 認証情報は、資料に書かない
  • 書けない箇所が、把握できていない箇所
  • 手順ではなく、判断の理由が要る
  • 認証情報は、資料に書かない

人に渡す資料を作ったとき、書けない箇所が出てきた。そこが把握不足だった。

書き始めて詰まった箇所

手が止まったのは、この種類だった。

  • なぜこの設定にしたのか
  • どこから見ればよいのか
  • 問題が起きたとき、何を疑うのか

どれも自分の頭の中にしかなかった。手順は書けても、理由が書けなかった。

手順だけでは渡らない

最初は手順だけ書いていたが、不十分だった。

  • 手順通りにいかない場面がある
  • そのとき、判断の材料が必要になる
  • 理由が書いてあれば、応用できる

3つ目が目的だ。手順は変わるが、理由は残る。

構成を決めた

書く項目を、先に決めた。

  • いまどうなっているか
  • どこを見れば分かるか
  • 何を決めて、なぜそうしたか
  • やっていないこと

4つ目を入れた。やっていないことを書かないと、やったと誤解される。

やっていないことを書く

この項目が、意外に重要だった。

  • 意図的にやっていないこと
  • その理由
  • やる場合の条件

2つ目を書くと、忘れていたのか、判断したのかが区別できる。

認証情報の扱い

資料に書かないものも決めた。

  • 認証に使う情報は、書かない
  • どこに保管しているかだけ書く
  • 一度やりとりに出たものは、変更する

3つ目を原則にした。資料に転記すると、資料自体が漏れる経路になる。

場所を書く

情報の置き場所は、必ず書いた。

  • どのファイルに書いてあるか
  • どの画面で確認できるか
  • 連絡先はどこか

2つ目が役に立つ。設定の値そのものより、確認できる場所のほうが長く使える。

読む人を想定する

誰が読むかで、書く内容が変わる。

  • 同じ作業をする人向けか
  • 引き継ぐ人向けか
  • 将来の自分向けか

3つ目の場合が多い。半年後の自分は、前提を忘れている。

分量の調整

長すぎると読まれないので、量も考えた。

  • 最初に全体の状況をまとめる
  • 詳細は後ろに置く
  • 最初の部分だけ読めば、状況が分かる形にする

3つ目が条件だ。全部読まなくても、使える形にする。

作りながら直した点

資料を書く過程で、設定も直した。

  • 説明できない設定が見つかった
  • 使っていない設定が残っていた
  • 書きながら、整理することになった

3つ目が副産物だ。説明できない状態は、整理されていない状態だった。

更新の仕組み

作った後の扱いも決めた。

  • 変更したら、資料も直す
  • 直せないなら、日付を入れておく
  • 古い資料は、古いと分かる形にする

3つ目が現実的だ。更新が追いつかない前提で、日付を残す。

渡したあとの反応

実際に読んでもらって、分かったこともある。

  • 前提の説明が足りない箇所があった
  • 自分が当たり前と思っている部分
  • 聞かれた箇所を、資料に追記した

3つ目を繰り返すと、資料が実用的になる。聞かれた箇所が、足りない箇所だ。

図を入れるか

文章だけで足りるか迷った箇所もある。

  • 構成の説明は、図があると速い
  • 手順は、文章のほうが追える
  • 図は作るのに時間がかかる

3つ目を考えて、構成だけ図にした。全部図にすると、更新できなくなる。

作ってよかった点

手間はかかったが、作った効果はあった。

  • 自分が状況を思い出すのに使っている
  • 相談されたとき、資料を見せれば済む
  • 整理されていない箇所が見つかった

1つ目が一番使っている。結局、自分が最も読む読者だった。

書く順番

資料を書く順番も、やってみて分かった。

  • 先に項目だけ並べる
  • 書ける項目から埋める
  • 書けない項目を、最後に調べる

3つ目が把握不足の部分だ。書けない項目を集めると、調べる対象が明確になる。

量より項目

最後に、資料の質について書く。

  • 長く書いても、読まれるとは限らない
  • 項目が揃っているほうが、使える
  • 足りない項目は、聞かれて分かる

2つ目を優先した。各項目が短くても、揃っていれば探せる。

まとめ

  • 書けない箇所が、把握できていない箇所
  • 手順だけでなく、判断の理由を書く
  • やっていないことと、その理由も書く
  • 認証情報は書かず、保管場所だけ書く
  • 聞かれた箇所を追記していくと、実用的になる

AUTHOR

北海道のWEB屋

北海道を拠点に、Web業界14年・サポート実績1,000件以上。WordPressの復旧、サーバー移転、独自ドメインとメールの設定、PHP・JavaScriptの修正まで対応します。相談と見積もりは無料です。

関連記事

RELATED