最近若手プロパの異動が決まり資料作成を行ってましたが、残念ながら出来はいまいちでした。

その資料を見て。注意するべき点がいくつかあったので、簡単に記載します。

・資料を読む対象は？

業務知識0で来る人を対象として作成されるのがいいです。

・資料は何を伝える為のもの？

伝えたい内容が何であるのか不明な資料になっていないか。

手順の説明をしたいのか、残AIを伝えたいのか、設計資料なのか

・フォーマット

見慣れたフォーマットであるべきです。

図表を用いるならUMLのルールに従う、関数仕様なら公式リファレンスに寄せる等

要所を抑えないと独りよがりな資料で終わって、結局意味が判らない無駄な資料になってしまいます。

The following two tabs change content below.

• この記事を書いた人
• 最新の記事

中村 圭吾

最新記事 by 中村 圭吾 (全て見る)

• Gitを使ってみよう④ - 2022年7月31日
• Gitを使ってみよう③ - 2022年6月30日
• Gitを使ってみよう② - 2022年5月30日