ドキュメンテーション技術

こんばんわ!あだきちです!

先日の一日研修の中で外部講師を招いてドキュメンテーション技術について講義頂きました。
ドキッとする内容(だめな例をやってしまっていたり・・・)もあり、反省の意味も込めてとても勉強になりました。先生、ありがとうございました。

 

 

 

 

 

wiki先生は「ドキュメンテーションはソフトウェア開発の重要な部分を占めているが、見過ごされることが多い。」とおっしゃっています。
確かにシステム開発では多くの時間をドキュメント作成に費やします。しかし新人研修などではフォーカスされることはなぜなんでしょうね。(優先順位の問題ですかね?)

こちらのサイトには文書作成の注意点が載っています。
「文章を記述する際の基本は、1つの文章で1つの内容(事柄、情報など)だけを伝えることです。1つの文章で多くの内容を伝えようとすると、長くて分かりにくい文章になってしまいます。」
なるほど・・・勉強になります。
メールの文章が読みやすい人と、そうでない人がいますが、こういうこともひとつの要因だったんですね。

その他、このような注意点があります。
●文章を継続する表現を使わず、主語が1つだけの文章にする
●修飾語を短くする
●述語を主語の近くに記述する
●主語を省略できるかできないかを判断する
●条件節の後には肯定形を使う
●二重否定を使わない
●部分否定を使わない
●「~のように」と否定形の組み合わせを使わない

正直ほとんどの項目を意識していませんでした。。