September 25, 2009

SEのための「構造化」文書作成の技術

SEのための「構造化」文書作成の技術
SEのための「構造化」文書作成の技術

キーワード:
 佐藤健、SE、ライティング、ドキュメント、構造設計
現役のエンジニアによって、構造を考えて書く方法が示されている本。技術本は目次が超重要箇所なので、多めに抜粋。
  1. 第1章 書くということ
    1. 1.1 技術文書の問題点
    2. 1.2 技術文書の種類
    3. 1.3 テクニカルライティングとは
    4. 1.4 読解力から「書く力」へ
    5. 1.5 書くことで頭を整理する
    6. 1.6 「 書く力」をビジネスの武器に
  2. 第2章 文書のプランニング
    1. 2.1 文書作成のステップ
    2. 2.2 プランニング工程の作業
    3. 2.3 メッセージを明確にする
    4. 2.4 アブストラクトの書き方
    5. 2.5 文書タイトルの付け方
  3. 第3章 材料の収集
    1. 3.1 材料収集工程の作業
    2. 3.2 日常生活での心構え
    3. 3.3 Webの活用
  4. 第4章 文書の構造設計
    1. 4.1 構造設計工程の作業
    2. 4.2 文書の構造化
    3. 4.3 演繹法と帰納法の活用
    4. 4.4 文書の構造を決める
    5. 4.5 目次の作り方
    6. 4.6 パラグラフを意識する
  5. 第5章 文書の執筆
    1. 5.1 執筆工程の作業
    2. 5.2 明確な文章を書く
    3. 5.3 事実と意見を区別して書く
    4. 5.4 用字/用語などの使い方
    5. 5.5 読点の使い方
    6. 5.6 箇条書きを活用する
    7. 5.7 図表の活用
    8. 5.8 執筆ルールの作成
  6. 第6章 文書の推敲
    1. 6.1 推敲工程の作業
    2. 6.2 推敲のチェック項目
    3. 6.3 推敲の事例
    4. 6.4 ビジュアル表現の工夫
  7. 7章 文書作成技術の応用
    1. 7.1 要求仕様書の書き方
    2. 7.2 システム提案書の書き方
    3. 7.3 マニュアルの書き方
    4. 7.4 調査レポートの書き方
    5. 7.5 小論文の書き方
    6. 7.6 論文の書き方
    7. 7.7 論文試験問題の書き方
  8. 付録
    1. 付録1 英文マニュアル作成から学ぶ
    2. 付録2 電子メールの書き方
    3. 付録3 演習問題
    4. 付録4 演習問題解答例
(目次から抜粋)
目次を見ると、大体どんなことが書いてあるか想像できると思う。一応、この本の概要を簡単に紹介しておく。

この本の目的は、IT技術者に書く力を身につけてもらい、よりすばらしい成果を出していただくこととある。文書作成の肝は、いきなり闇雲に書き始めるのではなく、事前にプランニングし、書きたいことを構造化してから書くべし、とある。

この本はかなり勉強になることが多く示されており、どこを紹介するべきか迷ってしまう。

まず、この本で示されているテクニカルライティングとは何かを紹介しておく。

テクニカルライティングとは、技術的な内容をわかりやすく、かつ正確に書くための技術であり、以下のポイントがあるようだ。
  • テクニカルライティングは、技術文書を書くための手法である
  • テクニカルライティングは、ビジネス文書にも応用できる
ビジネス文書にも応用できるというのがポイントとなる。

また、文書を「書く力」は、読解力を身につけることで身につき、同時に書くために思考する過程で思考力が身につき、それが読解力にもなると示されていた。この関係は、このような読書ブログを3年以上やってきた経験から、納得できるものである。

「書く力」について、なるほどと思った部分があるので、以下に引用。
 「書く力」は、その基になる読解力や考える力が付かないとうまくいきません。コンピュータにたとえれば、読解力は入力装置であり、考える力は処理装置であり、「書く力」は出力装置です。これらの装置がうまく連携することにより、より良いアウトプットが生まれることになります。
 物事をうまくまとめ、うまい文章をまとめることができるということは、1つの大きな能力です。優れた能力を身に付けることは、人生における1つの「武器」になりえます。ものを書くのが苦手な人が多いので、これは大変貴重な力です。
(pp.32)
普段何気なくこの読書ブログを更新していたり、仕事で設計書などを作成しているが、これはあまり意識したことはなかった。また、以下もなるほど思った。
 仕事の成果は、表現されたもので測られます。日常のビジネスの場では、報告書、記録、議事録、メモ、メールなど、書いた結果で、相手はその成果を推し測ります。書く力には、書くべき内容を作り出す力が必要です。さらに、その書いたものを相手に伝えるコミュニケーション能力も必要です。「書く力」を持っているということは、ビジネスにおいて、最強のツールを持っていることだといえるでしょう。したがって、この能力をビジネスの「武器」といってもよいと思います。
(pp.38)
自分はかなり「書く力」を意識的に身に付ける努力をしてきた。それがビジネスにおいて、最強のツール、「武器」になりえるというのは、自分のやってきたことが間違いではなかったということになる。
 
ウェブやブログ、メールが発達した現在では、昔よりも書く量が格段に多くなっていると思う。しかし、書くことの気軽さに反して、実際に読むに耐えうる文章が示されているものはそんなに多くはない。誰でもなんとなく文章を書いているような状況ではあるが、本当に価値ある成果物としての文章は、真に「書く力」に裏打ちされたものによって作成される。そういう「書く力」は、このような本を読んで意識的に磨かないと、なんとなく書いているだけでは絶対に身に付かないと思う。

また、『SEと文書作成』では、以下のように示されていた。
 ビジネスで「書く力」を最も必要としているのは、SEといってもよいでしょう。SEには単に文章を書くだけでなく、それにより、ユーザに説明を行い、納得させて、仕事を請け、それを完成させるという業務があります。システム提案書、アプリケーションシステムの仕様書、報告書、議事録、成果発表資料など、作業のあるところには必ず文書作成が伴います。ユーザに理解してもらい、行動をとってもらうためには、納得できる、理解しやすい文章が必要です。若いSEにこそ、「書く力」をビジネスの武器にしてほしいと思います。
(pp.40)
SEとなると、プログラムを書くよりも設計書やマニュアル、提案書などを書くことが多くなってくると思う。これはかなり実感するところで。なので、上司や偉い人には、日本語作成能力、つまりテクニカルライティング能力がかなり重要になるからしっかり磨いておけと言われたりする。そのため、文書作成能力がそのままSEの能力を反映するといっても過言ではないと思う。

自分の職業がSEということもあり、ライティング能力の獲得は必須ということになる。そういうこともあり、この読書ブログではキャッチフレーズの羅列ではなく、ちゃんとした文章を書くようにしている。その訓練を入社直後から3年半近く行ってきたので、ライティングにはそれなりに自信がある。実際プロジェクト先ごとに、自分の書いた成果物がかなりほめられたりする。

この本では、文書作成のステップは、プログラム開発のステップと考え方が似ていると示されている。
  1. プランニング
  2. 材料収集
  3. 構造設計
  4. 執筆
  5. 推敲(見直し)
上記の5ステップが、プログラム開発工程の各ステップ、1.プランニング(基本設計)、2.機能設計、3.詳細設計、4.コーディング(製造)、5.検査に対応するようだ。これはなるほどなぁと思った。特に重要なのは、主題を選定する、文書の目的を明確にする、誰が読むのかを明確にするといった、最初の工程のプランニングらしい。また、各工程の詳細は、実際に読んで確かめてほしいと思う。

執筆時に気をつけなければいけない具体的なことも多く示されている。文章は短くするとか、できるだけ能動態で書くとか、読点をなるべく多めに使用するべきとか。それらを読むと、自分ができている部分とできていない部分がはっきりわかる。文章を短くするとか、あまりできていない・・・。ついつい長くなりがちだ。

さすがにわかりやすい文書の作成指南本であるので、かなりわかりやすい内容だと思う。技術系の本は、翻訳本ではないのに1回読んだだけでは頭に入らないものがたまにあるけど、この本はそんなことはまったくない。ダメな例を改善したり、図解も多く示されているので、よい内容だと思う。

「書く力」は、大きな武器になるということがわかってよかった。また、もともと書くのが好きだというのもあったり、将来は本を書こうと思っているので、自分の「書く力」をもっと磨いていきたい。

IT技術者の人は、買って読んで損はないと思う。案外普段書いている文章は、自分ではわかりやすいと思っていても、そうではない場合が多いので。

他にもライティングに関する本は、以下のものがお薦め。どれもわかりやすいし、すぐに役立つ内容である。



SEのための「構造化」文書作成の技術
SEのための「構造化」文書作成の技術
著者:佐藤 健
販売元:技術評論社
発売日:2008-10-18
おすすめ度:4.0

読むべき人:
  • SEなどの技術者の人
  • 文章を書くのが苦手な人
  • ビジネスで最強の能力を身につけたい人
Amazon.co.jpで『文書作成』関連の他の本を見る

bana1 最強の武器獲得クリック☆  にほんブログ村 本ブログへ



トラックバックURL

コメント一覧

1. Posted by とんちゃん   September 12, 2010 14:06

4 > 物事をうまくまとめ、うまい文章をまとめることができるということは、1つの大きな能力です。優れた能力を身に付けることは、人生における1つの「武器」になりえます。ものを書くのが苦手な人が多いので、これは大変貴重な力です。(pp.32)

この文章で、「武器」は身に付けた「優れた能力」でしょうか、それとも「優れた能力を身に付ける能力」でしょうか? 「これは大変貴重な力」の「これ」は、厳密には何をさしているのでしょうか? 英文では、こうしたあいまいさは許されません。

コメントする

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