専門用語は徹底的に「読み手指向」で書くべし:誰にでも分かるSEのための文章術(7)(2/2 ページ)
「提案書」や「要件定義書」は書くのが難しい。読む人がITの専門家ではないからだ。専門用語を使わず、高度な内容を的確に伝えるにはどうすればいいか。「提案書」「要件定義書」の書き方を通じて、「誰にでも伝わる」文章術を伝授する。
複数の意味を持つ用語は、別の表記に書き換える
専門用語には、表記が同じで複数の異なる意味を持つものがあります。こうした専門用語は、意味が明確に分かるように表現しなければなりません。以下、技術者がよく使う「複数の意味がある専門用語」をいくつか紹介していきます。
「フォーマット」
例えば「フォーマット」という単語は、「(ハードディスクなどの)初期化」と、明確に分かるように記述する必要があります。
顧客管理データを保存するディスクのフォーマットに注意しなければならない。
顧客管理データを保存するディスクの初期化に注意しなければならない。
顧客管理データを保存するディスクの初期化(フォーマット)に注意しなければならない。
一方、下記の文章はどうでしょうか。もしかすると読者が「顧客管理データが保存されたディスクの初期化」と読み間違えてしまうかもしれません。この場合は、「(入出力データなどの)データ形式、書式」と明確に分かるように記述します。
顧客管理データのフォーマットに注意しなければならない。
顧客管理データのデータ形式に注意しなければならない。
「コード」
「コード」という単語には「プログラムコード」「文字データ」「商品コード」など、複数の意味があります。そのため、意味に合った用語を使用する必要があります。
設計仕様を確定した後、すぐにコードの作成を開始する。
設計仕様を確定した後、すぐにプログラムコードの作成を開始する。
新しいシステムに対応するように既存のデータのコードを変換する。
新しいシステムに対応するように既存の文字データのコードを変換する。
コードを用いてシステム内で1つ1つの商品を識別する。
商品コードを用いてシステム内で1つひとつの商品を識別する。
「サポート」
「サポート」という単語には、「顧客サポート」「対応」などの意味があります。
システムを納入した後のサポートが重要である。
システムを納入した後の顧客サポートが重要である。
このアプリケーションソフトはA社製のプリンタをサポートしている。
このアプリケーションソフトはA社製のプリンタに対応している。
「ASP」
表記が同じで複数の異なる意味を持つ英文字の略語には、特に注意します。 「ASP」には、「Application Service Provider」「Active Server Pages」など、複数の意味があります。何を指しているのか明確に分かるように記述します。
今回のシステムではASPを利用してコストを低減する。
今回のシステムではアプリケーションサービスプロバイダ(ASP)を利用してコストを低減する。
今回のシステムではASP(Active Server Pages)を利用してコストを低減する。
------------欄外------------
ASP(Active Server Pages):マイクロソフト社のWebアプリケーション作成の技術
「AP」
「AP」には「アプリケーションソフトウェア」「アクセスポイント」など、複数の意味があります。1つの文書中で、「AP」を異なる意味で使うと読み手が戸惑います。略語を使わずそれぞれ日本語で記述すれば、きちんと理解してもらえます。
- AP→アプリケーション/アプリケーションソフト/アプリケーションソフトウェア
- AP→アクセスポイント
用語の使い方は正確に。不完全な用語を使わない
技術者同士であれば、用語の一部を省略したり多少不正確な用語を使ったりしても、十分に意味を理解できます。しかし、情報システム関連でない部門の人(特に経営陣や管理職)には、それでは理解してもらえません。きちんと正確に記述する必要があります。
「プリント」
入金データを処理し、その結果をプリントする。
「プリント」という用語が、このままでは「印刷」なのか「表示」なのか「書き込み」なのかが不明です。技術者にとっては、出力先が変わるだけで、どれも同じ「プリント」です。しかし、顧客には意味が分かるように表現しなければなりません。
入金データを処理し、その結果を画面に表示する。
入金データを処理し、その結果をプリンタで印刷する。
入金データを処理し、その結果をファイルに書き込む。
「ウイルス」
専門用語としては「ウイルス」でもかまわないが、一般の人には分かりにくいでしょう。「ウイルス」は「コンピューターウイルス」と記述します。
「アプリ」
「アプリ」は、「アプリケーションソフト」など、略さずに記述します。
「アドレス」
「アドレス」は単体で使わないで、ケースに応じてきちんと記述します。
- 「アドレス」→メールアドレス、IPアドレス、MACアドレス、メモリーアドレス、ディスクアドレス
専門用語の表記を統一する
技術者は、1つの文書中で「同意味・別表記」の専門用語を混在させて使いがちです。書き手に違和感がなくても、読み手は混乱してしまいます。たとえ一般に認知されている専門用語であっても、表記の混在は読み手に負担をかけます。例えば、次のような専門用語です。
- ユーザーインターフェイス/インターフェイス/GUI
- メモリ/記憶装置/ストレージ
- ハードディスク/ディスク
- 画素/ピクセル
- 実装/プログラミング
- コピー/複製
- プロトコル/通信プロトコル/通信プログラム
- ウイルス対策ソフト/ワクチンソフト
- 出力 / アウトプット/プリント/印刷/表示/書き込み
文書で使用する専門用語は、表記とそれに対応する意味を初出の時点で明確にしておきます。それ以降は、必ずその表記で統一しなければなりません。
今回は、専門用語を分かりやすく表現するためのポイントを紹介しました。次回は、「技術者に特有の分かりにくい表現」を改善するポイントを説明します。
著者紹介
谷口 功 (たにぐち いさお)
フリーランスのライター、翻訳家。企業にて、ファクシミリ通信網を使ったデータ通信システム、人工知能、日本語処理関連のソフトウェア開発、マニュアルの執筆などに関わる。退職後、コンピュータ、情報処理、通信関連の書籍の執筆、翻訳、各種マニュアルや各種教材の執筆に携わる。また、通信、コンピュータ関連のメールマガジンの記事、各種雑誌においてインターネット、パソコン関連の記事やコラムなども執筆。コンピュータや通信に関連する漫画の原作を執筆することもある。 主な著作は、『SEのための 図解の技術、文章の技術』(技術評論社)、『ソフト契約と見積りの基本がよ〜くわかる本』『よくわかる最新 通信の基本と仕組み』(秀和システム)、『図解 通信プロトコルのことがわかる本』『入門ビジュアルテクノロジー 通信プロトコルのしくみ』(日本実業出版社)、『図解 ネットワークセキュリティ』『マスタリングTCP/IP IPsec編』[共著](オーム社)など。
- システム開発を成功させたいSEに送る、「文書執筆のおきて」まとめ
- マニュアル執筆が怖くなくなる、12の執筆ポイント
- 「目次」の良し悪しが、すべてのマニュアルの良し悪しを決める
- 知るだけで天地の差が出る、テスト仕様書の必須項目&表現方法
- 「バグ数には興味ないのだよ」――顧客が喜ぶテスト仕様書とは?
- 論理的なプログラムを書くプログラマは、論理的な文章も書けるか?
- 文書ごとに最適な「構成のフレームワーク」は異なる
- さらば、翻訳調の文章! 技術者向け校正ルール
- 専門用語は徹底的に「読み手指向」で書くべし
- 読みやすい文章の極意は「修飾語」にあり
- ドキュメントの質を確実に上げる6つの文章作法
- 「要件定義書のアウトライン作成」完全マニュアル
- 分かりやすい提案書はアウトラインが美しい
- ヒアリング現場で使えるコミュニケーション力
- 開発工程でSEが書く文書の基本
Copyright © ITmedia, Inc. All Rights Reserved.