全3495文字
PR

仕様書に出てくる「あの言葉」は要注意、悪文から学ぶ文章術

 次は、開発現場での文章スキルを取り上げます。

 以下は、あるシステム開発プロジェクトの仕様書の一部です。この中に、手戻りや障害を引き起こしかねない言葉が含まれています。いったいどの言葉でしょうか。

よくある文例
<ユーザー管理機能>
ユーザー管理機能は、各ユーザーが持つ以下の情報について管理する。
(a)社員番号
(b)氏名
(c)入社年月日
(d)所属組織
(e)…

 要注意なのは、「管理」という言葉です。「管理」は抽象度が高く、さまざまな意味を持ちます。抽象度が高い分、書き手にとっては便利な言葉で、深く考えずついつい使ってしまいがちです。

 先ほどの文例には、管理の対象は列挙されていますが、それらについて何をするのかは書かれていません。これを読んだ人は、それぞれの経験やノウハウを基に「管理」の意味を解釈するでしょう。その解釈は人によって異なる可能性が高く、トラブルの種になります。

 では、どのように書けばトラブルを回避できるでしょうか。次のような具体的な記述にする必要があります。

修正した文例
ユーザー管理機能は、次の機能を有する。

(1)ユーザー属性情報を登録する機能
(2)ユーザー属性情報を修正する機能
(3)ユーザー属性情報を削除する機能
(4)ユーザー属性情報に変更がある場合に、指定された管理者にメールを送信する機能
上記(1)~(4)の機能で扱うユーザー属性情報は次の通り。

(a)社員番号
(b)氏名
(c)入社年月日
(d)所属組織
(e)…

 「管理」以外にも、注意が必要な言葉はたくさんあります。代表的な例を、「開発ドキュメントの悪文修正術[抽象的な表現]」で紹介しています。現場によくある悪文の修正を通じて、適切な文章の書き方を解説する講座です。