はじめに
ドキュメント作成でいつもたくさんレビュー指摘をもらう人のための記事です。
この記事は
- 私自身が1年目で作成した成果物に対していただいた指摘内容
- レビュー実施する前に確認しておけば良かったと思ったこと
をもとに以下の確認観点を挙げました。
参考までに私がこれまで作成したドキュメントの多くは以下のようなものでした。
- Excel
- ある程度フォーマットが決まっている
- リリース作業の手順書
ただし、上記に関わらずできるだけドキュメントを作成する上での汎用的な自己レビュー観点を挙げられるように努めました。
私個人の備忘も兼ねています。
読者としては社会人1年目など、ドキュメント作成に不慣れな方を想定しています。
ドキュメント作成玄人には当たり前のことかもしれません。
目次
- ドキュメント作成前に
- ドキュメントの目的は何？
- ドキュメントの読者はどんな人？
- どんな順番で記述する？
- ドキュメントの作成完了の締め切りはいつまで？
- ドキュメント作成中に
- わからないことは聞く
- 1つの作業を途中でやめない
- こまめに修正する
- こまめに保存する
- ドキュメント作成後に
- みため
- ファイルの名称は適切か（エクセルだとシート名も）
- 自分で流れを通してみる（簡単にできる作業であればやってみる）
- 再レビューの場合
- おわりに
- 参考
ドキュメント作成前に
以下のことを先輩や上司に確認しメモを取りましょう。
わからないことがあれば、都度質問しましょう。
ドキュメントの目的は何？
作成するドキュメントが最終的にどのようなことを達成したいものなのか確認します。
ドキュメントの読者はどんな人？
以下の点を確認しましょう。
- どんな知識レベルの人？
- どのような状況の時に、ドキュメントを読む必要があるの？
どんな順番で記述する？
ドキュメントの目的と読者を踏まえてドキュメントの全体構成を考えます。
例えば、知識が少ないユーザー向けのマニュアルであれば、
基本的な操作から記述する必要があるかもしれません。
ドキュメントのひな形が存在する場合はこの項目の考慮は不要です。
ドキュメントの作成完了の締め切りはいつまで？
作成するドキュメントをいつまでに完成させればよいか確認しましょう。
そして、いつまでにどの程度終わってればよいのか計画を立てましょう。
ドキュメント作成中に
「ドキュメント作成前に」で確認した情報をもとに手順書を作成しましょう。
以下のことを心掛けましょう。
わからないことは聞く
不明な点や、作業前に確認し忘れたことは早い段階で聞いておきましょう。
多分これで良いだろう、という読みで作業を進めると間違っていた場合に
大幅な手戻りが発生します。
不確実なことはなるべく減らして、確実に作業を進めていきましょう。
1つの作業を途中でやめない
やっている作業を頻繁に変えないようにしましょう。
こまめに修正する
修正するべき点は気が付いたタイミングでやりましょう。
ただ、どうしても後で修正するのであれば、何をどう修正する必要があるのかメモし、後で確認しましょう。
こまめに保存する
アプリの不調でデータが飛ぶことがあるのでドキュメントの保存はこまめにしましょう。
ドキュメント作成後に
作成後5分ほど空けてから以下の作業に取り掛かりましょう。
なぜ5分空けるかというと、集中力を取り戻すためです。
トイレに行ったり、お茶を飲んだり、ほかの仕事を一度挟んでみたり、
新鮮な目で作成物を見れるようにしましょう。
みため
以下を確認しましょう。
- スペル、つづり
- インデント
- スタイル（エクセルなら罫線など）
- 不要なものは消し忘れていないか？
- 端から端まで見ているか？？（修正漏れ防止）
- 倍率を落として、全体を俯瞰的に見てみる
- 倍率を上げて、1項目ずつ細かく見てみる
ファイルの名称は適切か（エクセルだとシート名も）
作成物のファイル名が適切か確認しましょう。
自分で一読し、流れを確認する
実際に実施できる作業であれば内容の確認のためにやってみましょう。
実施が無理な作業であればシミュレーションしてみましょう。
再レビューの場合
これまでの内容を実施していれば、再レビューなど必要ない！
…と言いたいところですが、実際は仕様変更などで「やっぱり当初想定してた状況と変わったから対応して」なんてこともあります。
そのような場合は以下の手順でレビュー指摘への対応を実施します。
レビュー指摘の内容を確認する
指摘内容を確認します。
指摘内容自体が理解できない場合や、指摘への対応方法が思いつかない/わからない場合は質問しましょう。
レビュー指摘への対応をする
指摘への対応を1つずつ実施します。
以下のように、エディタなどに指摘内容をコピペして、実施したものからチェックマークを付けていくと漏れなく実施できます。
☑⇒実施済
☑ログイン処理を追加する
・実施コマンドを修正する
・キャプチャを追加する
レビュー対応後に
以下の確認作業を行ってください。
- レビュー指摘への対応を1つずつ確認
- レビュー指摘への対応によって修正が必要な部分が出ていないかの確認
例：手順書の作成
指摘への対応によって新規手順を追加した場合、
項番の修正が必要になる、など - 「ドキュメント作成後に」の「みため」部分を再確認
おわりに
慣れないうちは1つ1つ丁寧に実施しましょう。
参考
Qiita記事の書き方の参考
勝手に参考にさせていただきました！