連載
» 2010年02月26日 00時00分 公開

誰にでも分かるSEのための文章術(7):専門用語は徹底的に「読み手指向」で書くべし (1/2)

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

[谷口功,@IT]

 第5回「ドキュメントの質を確実に上げる6つの文章作法」第6回「読みやすい文章の極意は『修飾語』にあり」では、文章全体の「構造と型」を中心に、分かりやすく読みやすい表現法を紹介しました。

 今回から2回に渡って、文章の構成要素である「語句の使い方」や「表記法」を解説します。技術者が無意識に使ってしまう分かりにくい表現を紹介し、それを改善するためのポイントを提示します。

専門用語はきちんと説明する

 技術者は説明なしに専門用語を使ってしまいがちです。しかし、それでは読み手のことを考えた文書にはなりません。説明もなしに専門用語ばかりを使う文書を信頼しない経営陣や管理職もいます。専門用語は、意味を説明してから使うようにします。

 ただし、一般に浸透し、認知されているものは説明なしに使います。一般に認知されているかどうかは、新聞や主要なビジネス雑誌の記事を参考にするとよいでしょう。これらの記事で説明なしに使われている用語は、一般にも認知されているはずです。例えば、下記のような用語です。


クリック、ブラウザ、サーバ、サイト、サイバー攻撃、アプリケーションソフト、ダウンロード、ユビキタス、USBメモリ、クラウドコンピューティング、コンテンツ


 一般的に浸透していない専門用語は、初めて使用する個所で説明しておかなければなりません。説明の書き方には次のようなものがあります。

文章の流れの中に、説明を組み込む

外部から社内ネットワークへのアクセスにはワンタイムパスワードを使用する。ワンタイムパスワードの使用で、不正アクセスを防止し、安全を確保できる。


 上記の文章では、読み手が「“ワンタイムパスワード”って何?」と感じてしまいます。文章の展開の中で、用語の説明を組み込みましょう。読み手に違和感を持たせないように、説明の前や後の文章との調和を考えて、うまく表現します。

外部から社内ネットワークへのアクセスにはワンタイムパスワードを使用する。ワンタイムパスワードは一度しか使用できない使い捨てのパスワードである。このため、パスワードの盗聴や盗難は起こり得ず、不正アクセスを防止し、安全を確保できる。


用語の後にカッコ書きで説明を記述

 簡潔に一言で書ける説明であれば、カッコ書きを使用します。もっとも、( )内が長いと読みにくくなってしまうので、長い説明には使わないようにします。また、説明の代わりに、誰でも知っている具体例を紹介すると効果的な場合があります。

メールを暗号化して送信するためには、送信相手のデジタルID電子的な証明書)を入手しておかなければならない。


非接触ICカードスイカ、イコカ、パスモなどのカード)を利用して、商品の購買履歴、交通機関の乗降履歴、ポイントサービスの活用履歴などの情報を収集する。


欄外に注釈として説明を記述

 説明部分が複雑で長くなり、 上で説明した「カッコ書き」が使えないときには、欄外に注釈として説明を記述します。

2008年7月にDNSサーバの脆弱性が公表され、インターネット利用者に大きな衝撃を与えた。



 

2008年7月にDNSサーバ*の脆弱性が公表され、インターネット利用者に大きな衝撃を与えた。 

------------欄外------------

*DNSサーバ:インターネット利用に必要不可欠なサーバで、人間が理解できるメールアドレスやURLを、コンピュータが理解できるIPアドレスに変換する。また、その逆の変換も行う。


 「欄外の注釈」は、一部の(かなりの)読み手が用語の意味を知っていると予想できる場合にも有効です。なぜなら、用語の意味を知っている人は、用語の傍に説明があると煩わしく感じるからです。

今回のシステムではICタグを使用して商品を管理する。



 

今回のシステムではICタグ*を使用して商品を管理する。

------------欄外------------

*ICタグ:ICチップのメモリーを備えた、非常に小型で薄いタグ(荷札)


略語を多用せずに日本語で記述する

 IT関連の文書では英文字の略語をよく使います。技術や概念に関する用語だけでなく、規格名、団体名、会社名、製品名などにも略語を使用します。

  • PC→パソコン
  • HD→ハードディスク
  • DBMS→データベース管理システム

 技術や概念に関する略語は、できるだけ使わずに日本語で記述します。ただし、HTMLやTCP/IP、CAEのように、それ自体で専門用語と認識されているものは略語のまま使わなければなりません。もちろん、日本語にするものであれ略語のまま使うものであれ、顧客に分かりにくい専門用語は説明が必要です。

固有名詞を表す略語は、略語と日本語両方で説明する

 団体名、会社名、製品名などを表す略語は一般的に元の固有名詞の頭文字をつなげたものです。その固有名詞の日本語名と略語を併記すればよいでしょう。日本語名を略語の後にカッコ書きで記述します 。

LANの代表といえるイーサネットの標準規格はIEEE米国電気電子技術者協会)が制定している。


 下記のように日本語名にすると長い場合は、注釈を付けて略語を使うとよいでしょう 。

日本国内で使われるIPアドレスはJPNICが統一的に管理している。



 

日本国内で使われるIPアドレスはJPNIC*が統一的に管理している。

------------欄外------------

*JPNIC:社団法人日本ネットワークインフォメーションセンターJapan Network Information Center


       1|2 次のページへ

Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

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

メールマガジン登録

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