今日はドキュメント作成のTips。
今日の結論から。
どんなドキュメントだも順序は大切です。
また、なぜ書くのか、何を伝えたいのか、何をしてもらいたいのか。まずは目的とゴール、そこを押さえること。
何かを作り上げる手順書の場合、設定が正しく行われているかを確認するためのドキュメントを作ろうと思った時、何に気をつけますか。
もれなく重複せず、順序を守るこれが大切。
実際に現場で色々なドキュメントをレビューしてるとなぜこの順番で書かれてるんだ？と思いつきのような並び順で作成されたドキュメントを見かけます。
そんな並び順の手順書で実際に作業してみるとよく分かりますが、とてもやりづらい。かつ、間違えやすい。
だからこういった単純なドキュメントでもしっかりと作ることでみんな幸せになれるんですよ、と言いたい。
時間がない？いや、上から下、右から左に書いてくだけだから、少し気にするだけですよ。
なんてそんな単純ではないかもしれませんがもしイメージできなければ付箋に項目を書き留めて目の前で並び替えてみると、または落書きしてイメージを作ってから書いてみると整理できるかもしれません。
あとは矢張り実際に作業してみる、または作業する人に意見を聞くことも大切です。１人では気づかないことって結構あります。
レビューや見直しって大切です。
今日はこの辺で、いかがでしょうか？
