ドキュメントを作る時は目的を明確にする。 | ロマンチックなSEがIT業界を変える。

ロマンチックなSEがIT業界を変える。

アッツワークス株式会社 代表取締役 犬旅コンサルタントのブログです。
IT業界に入って25年。
システムエンジニア(SE)としての日々の活動記録。
キーワード は「右肩上がり」。
読者登録、大歓迎です。

IT業界で働くシステムエンジニアの皆様

設計書、お客様への提案書、トラブル発生時のお客様説明資料。。。システムエンジニアにとって、資料を作る場面はたくさんあります。が。。。

ドキュメントの作成を苦手、と思っているエンジニアは多いです。

もともと、国語が苦手→理系科目が好き→プログラマになる→エンジニアになる、といったパスが多いので、ドキュメント作成が得意です!という人は少ないのかもしれません。

理系のための資料作成術、といった書籍も出ていますが、本質を理解していないとテクニック的なものでは解決できません。

資料を作成する時に一番重要だと考えているのが、「目的」です。
誰のためなのか、そして何を伝えたいのか、を押さえているかどうか。
その次が論理展開です。パーツがきれいでも論理展開が破たんしていたら、伝わらないですよね。

もちろん資料作成に限りませんが、毎日毎回、目的を捉える、というクセをつけるのは大切だと考えています。

また、書きます。