11月05日学習ノート

[yorudennrei]

書籍「エンジニアが一生困らないドキュメント作成の基本」(https://amzn.asia/d/2GqgHaI) 123ページ　chapter5　ドキュメントの骨組みを組む　より読書開始

[yorudennrei]

なぜこの書籍を読むようにしたか

ドキュメント作成を苦手としているため。

どんなところが苦手なのか

内容を多く盛り込みすぎて複雑で読みにくいドキュメントを作成しがちである。

[yorudennrei]

もっとも重要なポイントは「なぜ」なので、内容に依存関係が無ければ「なぜ」から伝える。 つぎに「どうやって」→「なにを」につなげていく

[yorudennrei]

chapter8　chatGPTが出したテンプレートをどう修正すれば良いかは参考になる

[yorudennrei]

15:12読了。あとがきまで303ページ。 これから読み直しに入る

[yorudennrei]

感想

要件定義書、仕様書、ユーザーマニュアルなどのエンジニアが書くことが多いドキュメントで気を付けるべきポイントが記載されています。特に、5W1Hや伝わりやすい表現についての説明が多く含まれています。ツールの使い方に関しては、ExcelやWordの実例はありませんでしたが、ChatGPTを活用する上での改善例は参考になりました。