連載
» 2010年12月13日 00時00分 公開

システム開発を成功させたいSEに送る、「文書執筆のおきて」まとめ誰にでも分かるSEのための文章術(15)(2/2 ページ)

[谷口功,@IT]
前のページへ 1|2       

その3:文書の構成を作ってから、文書作成に取り掛かる

構成を作る方法についておさらい

 “まず、文書の構成を作る”という意識を持つことも、非常に重要です。分かりやすい文書にするためには、文書の構成をきちんと作り上げてから文章の記述に取り掛かるようにしなければなりません。

 構成を作る方法については、第3回「分かりやすい提案書はアウトラインが美しい」などで紹介してきましたが、ここで簡単におさらいしておきましょう。


 まず、文書全体の項目構成(大見出し・中見出し・小見出しの構成)を考え、次に各項目(大見出し・中見出し・小見出し)についての構成、さらに各パラグラフの展開構成を考えます。

なぜ構成を作る必要があるのか

 構成を作るのは、文書を論理的に構築するためです。「論理的に構築する」とは、文書を論理的に分割し、伝えたいテーマを論理的に展開し、冗長さや漏れ抜けをなくすことです。

 人間は基本的に、構成を作ることなしに文書を論理的に構築することはできません(天才的な能力を持つ人はこの限りではありませんが)。構成を作らないということは、設計図なしに家やビルを建てようとすることと同様です。どこかの時点で行き詰まり、破たんします。

 実際、技術者が記述する文書に限らず、新聞や雑誌の記事、テレビドラマや映画などは、必ず構成を考えてから、内容の記述や作成に取り掛かります。何らかの事柄を表現して伝えようとするときには、必ず構成を作り、それに基づいて表現していくように心掛けましょう。

その4:書き終えた文書を読み返す

第三者の目で、自分が書いた文書を評価しよう

 「文書を書き終えたら必ず読み返す」。この意識を持ち、実行するようにしましょう。このとき、単に読み返すのではなく、第三者の目で評価しながら読み返すことが重要です。

 書き終えた文書を読み返すのは面倒ですし、さらに第三者の目で評価するとなると、実行は簡単ではありません。しかし、相当に熟練した人か才能のある人でなければ、最初から読みやすく、何の瑕疵(かし)もない文書は書けないでしょう。

読み返すことで得られるメリット

 普通、最初に書き終えたバージョンは、読みにくい個所や分かりにくい個所がそこかしこに散見できる、未完成な文書のはずです(特に、文書作成に慣れていない人が書いたものはそうです)。読み返して、不都合な個所を修正することで、文書の質を高めましょう。

 自分が書いた文書を読み返し、第三者の目で評価することは、文書作成の力を向上させる訓練にもなります。読み直しをすると、つい書いてしまう分かりにくい表現、読みにくさの原因となる表現上の癖、思い込みで使っていた間違った語法などを洗い出せます。あらためて自分の文章を読み直すことで癖を自覚して改善していけば、文書作成力はめきめき向上していくことでしょう。


 分かりやすい文書は、開発プロジェクトをより良くするための大きな要因の1つです。エンジニアは、分かりやすい文書の書き方を身に付けることによって、開発プロジェクトをよりスムーズに、より適切に進行させることができるのではないでしょうか。

著者紹介

谷口 功 (たにぐち いさお)

フリーランスのライター、翻訳家。企業にて、ファクシミリ通信網を使ったデータ通信システム、人工知能、日本語処理関連のソフトウェア開発、マニュアルの執筆などに関わる。退職後、コンピュータ、情報処理、通信関連の書籍の執筆、翻訳、各種マニュアルや各種教材の執筆に携わる。また、通信、コンピュータ関連のメールマガジンの記事、各種雑誌においてインターネット、パソコン関連の記事やコラムなども執筆。コンピュータや通信に関連する漫画の原作を執筆することもある。 主な著作は、『SEのための 図解の技術、文章の技術』(技術評論社)、『ソフト契約と見積りの基本がよ〜くわかる本』『よくわかる最新 通信の基本と仕組み』(秀和システム)、『図解 通信プロトコルのことがわかる本』『入門ビジュアルテクノロジー 通信プロトコルのしくみ』(日本実業出版社)、『図解 ネットワークセキュリティ』『マスタリングTCP/IP IPsec編』[共著](オーム社)など。


前のページへ 1|2       

Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。