まだドキュメントに消耗してるの? 「ドキュメント作り」をカンガエルエンジニア

まだドキュメントに消耗してるの?

 

どうも、ミヤマです。

 

ドキュメントを作るとき、「なにを書けばいいのか分からない」という悩みってありません?

 

そうやって、無駄ドキュメント作り消耗するエンジニアは多いです。

僕もその一人でした。

 

でも、ドキュメントのパターンは決まっていますから、もう消耗する必要はありません。

 

もうドキュメントに消耗するのは、辞めにましょう。

 

今回はドキュメント作り消耗しないための本を紹介します。

 

 

ドキュメント作りに消耗しないための本3選

 


 

エンジニアを説明上手にする本 相手に応じた技術情報や知識の伝え方/開米 瑞浩

 

テーマは「説明のプレゼン」です。

プレゼンはドキュメント作りに関係ないと思われるかもしれませんが、プレゼン資料もドキュメントです。

ここで紹介される「ラベル」「構造化」を使ったドキュメント作りは、実践しやすくおすすめです。

 


一番伝わる説明の順番/田中耕比古

 

相手に何かを伝えるとき、それには順番があります。それはドキュメントに限らず、話すときもです。

相手の頭の中をイメージして、相手の欲しい情報を伝えなければなりません。

 

「んじゃあ、それってどうやればいいの?」

 

を解決してくれる一冊になっています。

 


なぜ重大な問題を見逃すのか?間違いだらけの設計レビュー改訂版/森崎修司

 

ドキュメントの種類によっては、レビューをもらうものもあるでしょう。

逆にレビューをすることもあるでしょう。

 

ただ、そのドキュメントレビュー消耗するのは、ナンセンスです。

正しいレビューがあってこそ、いいドキュメントです。

それを教えてくれる一冊です。

 

ドキュメントの必要性

 

「アドレナリンジャンキー プロジェクトの現在と未来を映す86パターン/トム・デマルコ,ピーター・フルシュカ」では、ドキュメントばかりつくることを「製紙工場」と言っています。

 

そして、ドキュメントは必要なものではないと考えるエンジニアも多いです

僕もその意見には賛成です。

 

僕らエンジニアがやることは、「ものづくり」であって、「製紙工場」ではありません。

 

ただ、「人月の神話/Jr.,Frederick P. Brooks」では、最低限のドキュメントは残すべきとあります。

 

ならば、僕らはその最低限のドキュメントで消耗しない為に、ドキュメントの作り方を知っておくことは必要です。

 

僕らエンジニアがやらないといけないのことは、「ものづくり」ですから。

 

 

あとがき

それでも、エクセルでなんでもつくるような文化が消えないのは、なにに原因があるんでしょうか?

 

エンジニアリングはすばらしいのに、無駄なドキュメント作りでうまく利用されていないエンジニアってたくさんいるように想像しています。

 

トップ画像素材↓

Joe Green

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です