全3413文字
PR

アイマイ表現3:主語の抜け

 「ドキュメントで、作業や操作、動作、振る舞いを表すとき、必ず主語をはっきりさせるようにしている」とSIerに勤務するDさんは話す。特に、受身形を使うと、主語が曖昧になりがちだ。その悪文の例を挙げる。

  • ログデータの容量が10Gバイトを超えると、前月同日より前のデータはバックアップを取った上で消去される

 システム要件を表したこの文は、最後が受身形になっている。そのため「バックアップを取る」「消去する」という2つの動作の主語が、システムなのか運用担当者なのかがはっきりしない。もしシステムであれば、システムの機能要件として扱う必要がある要件の漏れを起こさないためにも、主語を明確に表現すべきである。主語がシステムであるとき、それをはっきり書くなら、例えば次のような文になる。

  • ログデータの容量が10Gバイトを超えると、前月同日より前のデータについて、システムが自動的にバックアップを取り消去する

 「誰が」を表す主語だけでなく、「いつ」「どこで」「何を」「何のために」「どのように」の要素が抜けることもしばしばある。そこで「文章を書くときには、要素の抜け・漏れがないかどうか常に意識している」(Dさん)という。

アイマイ表現4:つい使ってしまう曖昧語

 パッケージ開発会社でディレクターを務めるEさんは、要件定義書や設計書のドキュメントを作成するとき、曖昧語を使わないように注意を払う。「意味が曖昧な言葉ほど、何にでも使えて便利。そのため、意識しないとつい曖昧語を使ってしまう」(Eさん)。

 以下にITの現場のドキュメントによく見られる曖昧語の代表例を挙げた。例えば「運用管理サーバーによってクライアントのエージェントソフトを管理する」の「管理する」という動詞は様々な意味を持つ。バージョン情報を取得する、エージェントソフトを起動させる、エージェントソフトが保持するクライアントの情報を収集する、といったことだ。極端に言えば、「管理する」は、対象に何かをすることしか表していないに等しい。

ITの現場のドキュメントで使われがちな曖昧語
ITの現場のドキュメントで使われがちな曖昧語
[画像のクリックで拡大表示]

 ほかにも、「最適化する」「処理する」「推進する」「対応する」など、曖昧な動詞はいくつもある。こうした曖昧な動詞は、できる限り具体的な言葉に置き換えたり例示したりすることを心掛けたい。

読み手によって基準は異なる

 「一般的な」「基本的な」「重大な」「十分な」といった程度を表す言葉も、読み手によって基準が異なるので注意が必要だ。具体的な数値を示したり、例示を入れたりして、誰が読んでも解釈が変わらないようにしたい。

 「瞬時に」「すぐに」「素早く」といった時間の短さを表す曖昧語も、要件定義書や設計書などのドキュメントでよく見受けられる。前出のAさんは、その中でも特に注意すべき曖昧語として「リアルタイムに」を挙げる。「リアルタイムにデータを連携させると書いてあったとき、同期か非同期かで設計内容が根本的に異なる」(Aさん)からである。

 このほかにも、「環境」「現在の〇〇」「これら/それら」「担当者」「当該の〇〇」など何を指しているのかはっきりしない曖昧語は枚挙にいとまがない。そうした曖昧語はリスト化しておき、具体的な言葉に置き換えることを習慣化したい。