ドキュメントレビューをする際の10のポイント | Ryuzee.com

みなさんこんにちは。@ryuzeeです。 重厚長大なドキュメントは、動かなかったり嘘が書いてあったり現実と異なっていたり、その上肝心なこと書いてなかったりということで辛いことが多いのが現状です。 今回とある筋からドキュメントをレビューする際のポイントを教えて欲しい、という依頼を受けたので書いてみます。 なお、個人的には、ドキュメントレビューよりソースレビューの方が重要だと思っています。 とはいえドキュメントレビューで肝心なのは、 ドキュメントレビューをするなら、その投資に見合う何を得るのか？を決めておく必要がある本当にそのドキュメントは必要か？をよく考える（会社のルールだから！というのは理由にはなっていない）だと思います。 レビューのポイント1. 体裁をレビューするのではなく、中身をレビューするひどい現場だと、文書のインデントやフォントのサイズ、誤字脱字ばかりを重箱の隅をつつくようにチェッ

[nyop]

今の現場の人たちに読ませたいなぁ。体裁の指摘が漏れててレビュアが非難されたりとか、何じゃそれって感じ。

[katzchang]

「会社のルールだから！という理由は考えていない答えだ」ですよねー

[kawaoso]

良記事

[sinsengumi-2]

[for:@twitter]