ChanduのSE雑記

SEとして業務をする中で、学んだことや気づいたことを書き留めていきます。

SE・プログラマの基本スキル向上 〜ドキュメント作成の進め方〜

f:id:Chandu:20180528220653j:plain

概要

よく上司に報告書を作ってほしいとか、テスト仕様書を作ってほしいとか、色々ドキュメント作成をすることがあると思います。

しかし、上司のイメージしているドキュメントと自分のイメージしているドキュメントが違い、作り直しになることは多くないでしょうか。

私はよくありました。。。

 今回は、ドキュメント作成で失敗しないためのちょっとしたコツを書いていきます。ドキュメント作成が苦手だなとかそういう人にぜひ見ていただき、少しでも役に立てばと思います。

100%の完成させてから見せない

全部完成させてから、上司などに見てもらうと、相手の想定と違う資料となり作り直しが発生する可能性があります。そのため、資料の方向性を示す資料を先に作成し見せることでお互いの認識を合わせることができます。この結果、細かな修正はあるかもしれませんが、大きな修正は必要なくなります。

プレゼン資料、報告書の進めかたの例f:id:Chandu:20180528212033j:plain

 

テスト仕様書の進め方の例

f:id:Chandu:20180528212235j:plain

エンジニアのためのWord再入門講座 美しくメンテナンス性の高い開発ドキュメントの作り方

エンジニアのためのWord再入門講座 美しくメンテナンス性の高い開発ドキュメントの作り方