February 02, 2009

SEのための図解の技術、文章の技術

SEのための図解の技術、文章の技術
SEのための図解の技術、文章の技術

キーワード:
 谷口功、SE、図解、文章読本、デザインパターン
SEのための文章や図解の基本的な表現方法が示されている本。以下のような目次となっている。
  1. 第1章 SEがユーザ/顧客に提示する文書
  2. 第2章  文書がユーザ/顧客にわかってもらえない理由
  3. 第3章  文書を構成する要素
  4. 第4章  平易で読みやすい文書の「構成」と「展開」
  5. 第5章  読みやすくわかりやすい日本語表現の基本技術
  6. 第6章  読みやすくわかりやすい文書にする図解表現技術
  7. 第7章  文書別の表現技術
(目次から抜粋)
この本は、読みやすくわかりやすい文書にする基本的な表現の方法/技術やルール、文章の構成、展開の方法/技術が示されている。以下にこの本の概要を引用。
 本書は、SEがユーザ/顧客に提示する文書を、読みやすくわかりやすいものにする指針の提供を意図しています。SEは、ユーザ/顧客だけでなく、開発グループの技術者に向けても、設計仕様書などの文書を作成します。本書の対象をユーザ/顧客を中心に捉え、彼らに向けて作成する文書をメインに置いたのは、開発グループの技術者向けの文書に比べて、「表現」が重要になるからです。また、ユーザ/顧客は、文書をシビアに見るために、それに応えることができるようなレベルの文書表現技術が必要になるからです。
(pp.4)
このように、ユーザに正しく理解してもらうことを主眼において、この本が構成されている。その方法として、分かりやすい文章の書き方、図解のパターンなどが示されている。

図解、文書についての示し方の本を読んだので、今回は練習もかねて図解を取り入れておく。

3,4,5章は分かりやすい文書の書き方が示されており、これは別にこの本でないと得られないものではない。特にこの本で重要なのは、システム開発業で作成される文書の種類とその目的について解説されている部分になる。以下、1章のまとめを自分なりに図解してみた。

文書の種類と目的

このようにドキュメントのタイプ別に書くべきこと、気をつけるべきことが示されている。

また、以下は、図解と文書の長所、短所についての自分なりの図解になる。

図解、文書の長所と短所

文章表現だけでは、冗長になりすぎたり、イメージがわかなかったりするが、図解を使えば全体像やイメージが把握しやすい。しかし、それぞれに一長一短があるので、それぞれを補完するように両方をうまく使いこなす必要がある。

図解を使うときに、図解の役割を明確にする必要があると示されている。以下のうち、どれなのかを考えるとよいようだ。
  • パラグラフで伝える内容を図解で表現し、それを補助的に説明するために本文を記述するのか
  • パラグラフで伝える内容を文で記述し、その内容をわかりやすく視覚化するために補助的に図解を使うのか
  • 図解と文を相互協働させ、相乗効果的にパラグラフの内容を分かりやすく説明するために図解を使うのか
    (pp.118)
そして、図解をパラグラフの中でどのような役割で使うのかは、そのパラグラフの内容によるらしい。これらの視点はあまりなかったので、とても勉強になった。何でもかんでも図解にすればいいというものではなく、文章、図解のどちらかをメインにして説明するかが重要なようだ。

文書の書き方も多く示されている。文章の構造や起承転結、読点の適切な位置、なるべく肯定文を使うといったことが示されている。特に修飾語を短くして分かりやすいものにすべきというのは、耳が痛いなぁと思った。このブログの文章は、割と長文の傾向がある。それは『〜の〜の〜の〜は』といった修飾語を一文で多用しすぎているということになる。これは気をつけようと思った。

この書評ブログで書評を書くときに、長文で示しているのは、文章作法のためという側面が強い。つまり、適切で分かりやすい文章をアウトプットするトレーニングということになる。優れたSEや技術者は、分かりやすく正しい日本語が書ける必要があるので。

設計書を書いて、上司にレビューしてもらうと、表現があいまいでどちらのことを示しているのかよくわからないと言われたことが多い。設計書は、自分たち作る側の人間だけが分かればいいというものでもない。設計書も納品成果物となっている場合、当然顧客もその内容を読む。顧客はもちろんITの専門家でないことが多いので、そのような人たちにも理解できるように示す必要がある。設計書やパワポの資料は、誰が読んでも一意に理解できるようなものを作れ、といつも上司にダメだしされていた・・・。

仕事であまりパワポを使ったりすることはないけど、いつそのような仕事が回ってきてもいいように図解のパターンを習得しておく必要があると思って、この本を読んでみた。図解だけでなく、基本的な文章作法やシステム開発業に必要な文書の書き方が示されており、とても勉強になった。

若手SEの人は絶対これは読んだほうがいいと思う。適切な文章を書いたり、図解で示せるようになるまで、これは何度も読み返そうと思う。

図解パワポ書評もありかなと思ったが、工数がかかりすぎる・・・。このエントリは2時間もかかっている。



SEのための図解の技術、文章の技術
SEのための図解の技術、文章の技術

読むべき人:
  • 文章を書くのが苦手な技術者の人
  • パワポで優美で分かりやすい資料を作りたい人
  • いつも上司のレビューでダメ出しされすぎている人
Amazon.co.jpで『谷口功』の他の本を見る

bana1 役に立ったらクリック☆  にほんブログ村 本ブログへ



トラックバックURL

コメントする

名前:
URL:
  情報を記憶: 評価:  顔   星