読みやすい文章の極意は「修飾語」にあり:誰にでも分かるSEのための文章術(6)(2/2 ページ)
「提案書」や「要件定義書」は書くのが難しい。読む人がITの専門家ではないからだ。専門用語を使わず、高度な内容を的確に伝えるにはどうすればいいか。「提案書」「要件定義書」の書き方を通じて、「誰にでも伝わる」文章術を伝授する。
具体的な用語を使用する
量、距離、時間、期間などについて、抽象的な表現や主観的な表現を使うと、読み手は恣意的に解釈してしまいます(“大量の”とはどれくらいの量か?“短期間”とはどれ程の期間か?)。意味を明確にするには、数値などを用いて具体的に表現します。数値で表せないものは、具体的な内容で表現します。
また、デジタルのデータ量などは数値で表してもぴんとこない読み手もいます。そこで、誰でも知っている具体的な数値を使うという配慮が必要なケースもあります。
今回開発するシステムは大量のデータを処理できる。
今回開発するシステムは1分間に**メガバイトのデータを処理できる。
**メガバイトのデータを格納する。
電話帳1冊分の文字情報に匹敵する量のデータを格納する。
短期間で検証作業を完了する予定である。
1週間で検証作業を完了する予定である。
冗長な表現を使わない
同じ表現を何回も繰り返したり、短い語でまとめられるところをまとめなかったりすると、文章が長くなって読みにくくなってしまいます。「冗長な文章」にしないためには、以下の点に注意します。
同じ表現を繰り返し使わない
同じ表現(語や語句など)を1つの文章中で何回も使うと読みにくくなります。また、誤解を招く原因になります。できるだけ同じ表現を多用しないようにしましょう。これは、まったく同じ表記でなくても意味が同じ表現(例えば、“保存する”と“書き込む”、“プリント”と“印刷”など)についても同様です。
新たに構築するシステムは、既存のシステムを更新するシステムであり、現在のシステムは、社内ネットワーク上のパソコンからのみ共有情報にアクセスできるシステムであるが、新しいシステムは、社外からもモバイルコンピューティングで共有情報にアクセスできるシステムである。
新たにシステムを構築する。これは既存のシステムを更新するものである。現在は、社内ネットワーク上のパソコンからしか共有情報にアクセスできない。一方、新しいシステムでは、モバイルコンピューティングで社外から共有情報へアクセスできる。
冗長な表現を多用しない
「〜することができる」「〜を行う/実行する」などの冗長な表現を多用すると、読みにくい文章になってしまいます。こうした表現を使わないで文章を記述します。
このコマンドの後には任意の値を設定することができる。このため、設定した値ごとに、システムの動作の確認を行わなければならない。この作業には時間がかかるため、テスト要員の追加が必要であると考えている。
このコマンドの後には任意の値を設定できる。このため、設定した値ごとに、システムの動作を確認しなければならない。この作業には時間がかかるため、テスト要員の追加が必要である。
おわりに
文章は、書いたらそれで終わりというわけではありません。必ず読み返しましょう。読み返して、他人が読んで意味が分かる文章になっているかどうか確認します。
このとき、読み手の客観的な目で評価することが必要です。そして、分かりやすい読みやすい文章になっていると確認できてはじめて文章を書き終えたことになります。
まとまった内容(例えば、1つの段落)を記述し終えたら、そこまでの文章を読み返して確認するようにしてください。
著者紹介
谷口 功 (たにぐち いさお)
フリーランスのライター、翻訳家。企業にて、ファクシミリ通信網を使ったデータ通信システム、人工知能、日本語処理関連のソフトウェア開発、マニュアルの執筆などに関わる。退職後、コンピュータ、情報処理、通信関連の書籍の執筆、翻訳、各種マニュアルや各種教材の執筆に携わる。また、通信、コンピュータ関連のメールマガジンの記事、各種雑誌においてインターネット、パソコン関連の記事やコラムなども執筆。コンピュータや通信に関連する漫画の原作を執筆することもある。 主な著作は、『SEのための 図解の技術、文章の技術』(技術評論社)、『ソフト契約と見積りの基本がよ〜くわかる本』『よくわかる最新 通信の基本と仕組み』(秀和システム)、『図解 通信プロトコルのことがわかる本』『入門ビジュアルテクノロジー 通信プロトコルのしくみ』(日本実業出版社)、『図解 ネットワークセキュリティ』『マスタリングTCP/IP IPsec編』[共著](オーム社)など。
- システム開発を成功させたいSEに送る、「文書執筆のおきて」まとめ
- マニュアル執筆が怖くなくなる、12の執筆ポイント
- 「目次」の良し悪しが、すべてのマニュアルの良し悪しを決める
- 知るだけで天地の差が出る、テスト仕様書の必須項目&表現方法
- 「バグ数には興味ないのだよ」――顧客が喜ぶテスト仕様書とは?
- 論理的なプログラムを書くプログラマは、論理的な文章も書けるか?
- 文書ごとに最適な「構成のフレームワーク」は異なる
- さらば、翻訳調の文章! 技術者向け校正ルール
- 専門用語は徹底的に「読み手指向」で書くべし
- 読みやすい文章の極意は「修飾語」にあり
- ドキュメントの質を確実に上げる6つの文章作法
- 「要件定義書のアウトライン作成」完全マニュアル
- 分かりやすい提案書はアウトラインが美しい
- ヒアリング現場で使えるコミュニケーション力
- 開発工程でSEが書く文書の基本
Copyright © ITmedia, Inc. All Rights Reserved.