連載

2010年6月14日

論理的なプログラムを書くプログラマは、論理的な文章も書けるか？：誰にでも分かるSEのための文章術（10）（2/2 ページ）

「提案書」や「要件定義書」は書くのが難しい。読む人がITの専門家ではないからだ。専門用語を使わず、高度な内容を的確に伝えるにはどうすればいいか。「提案書」「要件定義書」の書き方を通じて、「誰にでも伝わる」文章術を伝授する。

[谷口功，＠IT] PC用表示

LINE

Hatena

前のページへ | 　　　　　　

　以下では、「バランスのよい文章」にするための「文章の書き足し方・削り方」を紹介します。「書くべき文章はきっちり書き、削ってもよい文章はざっくり削る」。これが基本です。

無関係な記述を挟まない

　途中に文脈とは無関係な記述が挟まっている文章は、およそ論理的とはいえません。読み手を混乱させるだけです。

　インターネットの起源は、1960年代末に米国国防総省が中心になって実験用に開発したARPANETです。1989年には、米国立科学財団がNSFnetを構築して、全米の大学や研究機関を通信回線で接続しました。インターネットの本格的な始まりです。

　ただし、NSFnetは学術、教育目的の利用だけでした。1980年代の後半から1990年代の前半にはパソコン通信の利用が盛んでした。1990年代に入るとインターネットの商用化が始まります。1990年代の後半には世界中でインターネットのビジネス利用が進みました。そして、現在のような隆盛を迎えるに至ったのです。

　どこか違和感を覚える文章です。上記の例は「インターネットの変遷」についての文章であるはずなのに、無関係な「パソコン通信」についての記述が挟まっています。この文章があることにより、読み手は、このパラグラフで書き手が何を伝えたいのか理解できなくなってしまいます。読み手を混乱させないために、無関係な文章は省きましょう。

ただし、NSFnetは学術、教育目的の利用だけでした。1990年代に入るとインターネットの商用化が始まります。1990年代後半には、世界中でインターネットのビジネス利用が進みました。そして、現在のような隆盛を迎えるに至ったのです。

うっかり論理飛躍――「相手が知らない前提情報」は省かない

　しばしば、書き手が「これは記述するまでもないことだ」と判断して、文章を省略してしまうことがあります。しかし、読み手が必要とする情報を欠いた記述は、読みにくくなります。「これは自明のことだ」と思い込んで省略せず、必要な情報は必ず記述しましょう。大切なのは「読み手のことを考える」ことです。

なぜテストをするのか？

　下記の例文を見てください。一見正しい文章のようですが、少し問題があります。

　プログラムのバグは、テストで見つけ出して修正します。そのため、あらゆるシステム開発で必ずテストを行わなければなりません。

　なぜ、「必ずテストを行わなければならない」のでしょうか。上記の文章では、「『すべてのプログラムにはバグがある』と考えるのは当然だ」という情報が抜けています。そのため、文章のつながりが分かりにくくなっています。技術者にとって一見当たり前に見える記述には、往々にして「論理飛躍」があります。

　プログラムのバグは、テストで見つけ出して修正します。「すべてのプログラムにはバグがある」と仮定しなければなりません。そのため、あらゆるシステム開発で必ずテストを行わなければなりません。

必要な技術情報

TCP/IPを用いて組織内ネットワークを構築する例が増えています。これにより、組織内ネットワークでもインターネット技術を活用できます。広く普及しているインターネットの標準的な技術を活用することで、低コストで高機能のネットワークを構築できます。

↓
　

TCP/IPを用いて組織内ネットワークを構築する例が増えています。インターネットはTCP/IPを用いたネットワークです。そのため、組織内ネットワークでもインターネットの技術を活用できます。広く普及しているインターネットの標準的な技術を活用することで、低コストで高機能のネットワークを構築できます。

　上記の例では、「インターネットはTCP/IPで動作する」という情報を省いてしまいました。技術者にとっては常識である情報は、つい書き飛ばしてしまいがちです。しかし、そうした情報は一般人にとっては常識でないことが多いものです。「ほかの人は知らない」という前提に立って、必要な情報は省かないでおきましょう。

技術者が書きたがる「補足的な説明」は蛇足である

　先ほど、「前提となる文章は削らないように」とお伝えしました。とはいえ、書きすぎてもいけません。文章は、「過不足なく」記述するのがスマートです。

　ポイントは、「トピック対象についての補足的な解説を書かない」ことです。特に、技術的な説明や背景情報、歴史や変遷、固有名を挙げた事例紹介などは、補足的な解説になりがちです。うっかりこのような文章を書こうとしたときは、一度立ち止まって「補足的な解説かどうか」を検討し、蛇足であると考えるなら削りましょう。

具体的な実行方法、本当に必要？

　今回のシステムは、オブジェクト指向に基づいて開発します。オブジェクト指向分析で要件を分析、定義した後、オブジェクト指向設計でシステム仕様を設計します。実装は、オブジェクト指向プログラミングで行います。オブジェクト指向を採用することで、既存のプログラムを部品として再利用できます。これにより、システム開発の効率化を図ります。また、今回作成するプログラムを将来開発するシステムの部品として再利用することも視野に入れています。

↓
　

　今回のシステムはオブジェクト指向に基づいて開発します。オブジェクト指向を採用することで、既存のプログラムを部品として再利用できます。これにより、システム開発の効率化を図ります。また、今回作成するプログラムを将来開発するシステムの部品として再利用することも視野に入れています。

　上記の例では、途中で枝葉の情報を書き過ぎています。文章の流れの本道を外れて脇道に入ってしまい、なかなか元に戻らないのです。これでは、読み手が、「この記述はどこに向かっているのか」と、混乱してしまうでしょう。結果、そのトピックで伝えたいことが伝わりません。

技術の詳細や歴史はいらない

　今回のシステムでは、取引先との通信にインターネットVPNを使用します。インターネットVPNは、通信データのセキュリティを保護する技術を用いて、インターネット上に仮想的にプライベートな通信回線を構築する仕組みです。暗号化や認証の技術により、通信途中での盗聴や改ざんを防止し、通信相手の正当性を保証します。また、今回のシステムでは、VPNを実現するプロトコルとしてIPsecを使用します。これにより、IPレベルでセキュリティを確保できます。インターネットというパブリックな資源をプライベートに活用することで、低い通信コストで安全なネットワークを作り上げます。

↓
　

　今回のシステムでは、取引先との通信にインターネットVPNを使用します。インターネットVPNは、通信データのセキュリティを保護する技術を用いて、インターネット上に仮想的にプライベートな専用線を構築する仕組みです。インターネットというパブリックな資源をプライベートに活用することで、低い通信コストで安全なネットワークを作り上げます。

　「VPNの提案」のはずなのに、これでは読者は「これは技術解説なのだろうか」と戸惑ってしまいます。

　技術者は、機能や技術の説明を書かなかったり、一言だけで済ませてしまったりすると不安なのか、つい詳細に書き過ぎてしまいがちです。しかし、技術的な説明がなくても書き手の意図が伝わる場合は、思い切って文章を削りましょう。

　「書き過ぎると、かえってトピックとしての論理性がなくなってしまう」ことを、覚えていてほしいと思います。

著者紹介

谷口　功　（たにぐち　いさお）

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

「次回」へ

「誰にでも分かるSEのための文章術」バックナンバー