きっかけは、
「ドキュメント作成の時間短縮ってどうやったら出来るんだろう……」
っていうところから始まりました。
ドキュメント作成時の、おおまかな流れ
人によって違うとは思いますが...
①書く事を決める
- 仕様や要件に沿って、書く内容を決める。
②ざっくりと下書き
- ①のアウトライン書く
- アウトラインに沿って内容を書く
③自己レビュー
- 書いてる内容が正しいか確認
- 仕様や要件などに沿っているか確認
- 正しくなければ修正して再度確認
- 体裁や文章表現の確認
- ノイズを取り除く
- 固有名詞の統一
- 漢数字/算用数字の統一 など
- ノイズを取り除く
分析
①について
開発フェーズでいうところの「設計」。
仕様や要件に沿って書く事を決めるだけなので、
そこまで時間かからないかなと思ってます。
（実際に僕もここには時間かかってません。）
②について
開発フェーズでいうところの「開発」。
①が決まってれば、アウトライン書いて、内容をざざっと書くだけなので、
ここもそこまで時間かからないかなと。
③について
開発フェーズでいうところの「試験」。
ここが問題なんです。
試験のようにOK/NGが出るわけでもないので、「こうなれば正解」もないし、自分の裁量次第になる。
だから不安になって何度も見直す。
僕の場合、①②の2～3倍の時間がかかってます。
勿体ない。
しかも、自己レビューで修正する箇所なんて全体の1割程度。
勿体ない。(大事な事なので2回言いました)
つまり何が言いたいのかというと、
- 自己レビューにはあまり時間をかけず、さっさと他の人にレビューしてもらいましょう。←一番伝えたい事
- 何か良い方法教えて下さい。←一番聞きたい事
以上。