教育・訓練12月 報告

教育計画 12月

ドキュメントの書き方について、ここ数か月毎日のように悩んでいる。

「品質の良いドキュメントを書くには、結局は経験なのだから」っと言う方は多くいますが、本当にそうなのでしょうか?

私には、その結論がどうも納得いきません。

何かノウハウを身に付けたり、自分のドキュメントの書く際の意識を変えれば、ドキュメントの品質は上がるのではないでしょうか?

そう思いながら、webサイト「自分戦略@IT研究所」の記事『誰にでも伝わるSEのための文章術』(第1回~第6回)を読破。
 ※ 第4回は、正直内容が微妙だったので、読んでおりません。

URL:http://jibun.atmarkit.co.jp/lskill01/rensai/writing01/01.html

①『開発工程でSEが書く文書の基本』
【内容】
提案書、要件定義書(各仕様書も含む)の定義、分かりやすい文章術に必要な基本、どのような読み手でどのような表現が必要なのか?
を記載している記事である。
【感想】
人にとっては、当たり前だという点も多いですがが、大きなポイントとして「読み手について考えながら文章を作っているのか?」
私個人の意見としては、やはり頭のどこかでは「自分さえ理解していれば良い」という考えがあったのかもしれない。
「読み手の事を考えて文章を作る」言うのは簡単ですが、実際に実行して書くの難しい。
でも、少しずつ意識を変えていくべきだと思いました。

②『ヒアリング現場で使えるコミュニケーション力』
【内容】
綺麗な文章を書くためには、多くの情報が必要なってきます。
受注の仕事の場合は、顧客からどれだけ多くの情報を引き出すかが重要となります。
ここでは、顧客とのヒアリングの上手な方法を記載している。
【感想】
私の場合、聞きたい事だけをメモしてヒアリングに行っております。
ただ、聞きたい事をメモしてヒアリングに望んだだけでは、多くの情報を引き出すことはできない。
ヒアリングを行う際、どのようなストーリー構成になるのかを考え、聞き方、聞き取り方に注意しないといけないことがよくわかりました。

③『分かりやすい提案書はアウトラインが美しい』
【内容】
ここでは、ドキュメントの全体構図(階層構造)を考えるための内容が記載されている記事です。
【感想】
改修目的で元々のドキュメントが汚い場合はどうしようもないですが、新規で作成する場合、一番最初に考えるのはドキュメントの全体構図だと思う。
全体構図が綺麗ではないと、文章も汚くなくなる。これは一つ勉強になりました。

④『ドキュメントの質を確実に上げる6つの文章作法』
【内容】
主語述語を書き方、否定形の書き方などなど文章を書く際のポイントをまとめた記事です。
【感想】
この記事を読んで思ったことは「シンプルな文章ほどよく理解できる」
考えて考えて考え抜いて深みにはまり、読みづらい文章になっている(私の場合もそのパターンが多い)
実際は、そんなことを考える必要はない。伝えたいことをピックアップし、その内容をシンプルな文章にする。

⑤『読みやすい文章の極意は「修飾語」にあり』
【内容】
文章の書く際の修飾語の使い方について記載している記事です。
【感想】
④と同じ「シンプルな文章ほどよく理解できる」。
修飾語の使い方も極力シンプルにするのが良いと思いました。

皆様も一度読んでみては如何でしょう?


教育・訓練12月 報告” への1件のコメント

  1. ドキュメント力向上は永遠のテーマの1つと思っています。
    紹介してくれた記事は定期的に確認すると、同じ記事でも毎回違った気づきが得られるのではないかと思います。だからこそ永遠のテーマ。

コメントを残す