理系のための文書作成術(3) ―― 開発文書の書き方はしごとのやり方を示す

塩谷 敦子

tag: 組み込み

技術解説 2010年10月28日

●能動態記述で作業に自信と責任を持つ

 「受動態(受け身の文)を使わないようにしましょう」ということも,分かりやすい文章記述のために,しばしば指摘されることです.受動態が分かりにくいとされるのは,回りくどい言い方になり,主題の対象がぼけてしまいがちだからといえます.例えば,「○○が△△を□□する」と直接的な表現ができるところを,「△△が○○によって□□される」とすることで,回りくどい印象になります.さらに,書き手にこの表現を簡潔にしようという意識が働くと,「○○によって」の部分を省略してしまうことがよくあります.結局「△△が□□される」という,「□□する」のはいったい誰(何)なのかが不明の文が出来上がります.

 例として,受動態の文を多用した開発文書を図5に示します.

図5 受動態によるあいまいな表現を含む開発文書の例

 図中にある「入力データは...構成される」とはどういう意味でしょうか.入力データの構成をここで定義したことを述べているのでしょうか? もしくは,この文書ではなくほかの文書で既に定義されていることを,紹介として引用しているのでしょうか? 後者だとすると,引用元を記載するべきです.前者だとすると,本来は「構成する」という自らが行うことを述べているにも関わらず,「構成される」という受け身の表現を使うことにより,開発上の一つの作業としての責任の所在を不明にしているといえます.

 自らの行為を示すなら,受動態の表現はやめて,「入力データを,次表に示すように3種類で構成する」と能動態で書き換えるべきです.こうすることで,この章で要求されているはずの「入出力を定義する」ための一つの作業を明示して,為すべきことの責任を示すことになります.

 図5内のもう一つの例である「更新される」は,「○○によって更新される」の「○○によって」が抜けているために,「更新する」という開発上の処理を特定できません.

 筆者は,職業柄,組み込み技術者が書くソフトウェア開発文書をしばしば読む機会を得ています.そしてこれまで,受動態が頻繁に使われている開発文書を数多く見てきました.読者の中で,自分は受動態をよく使っているかもしれないと気付いた方は,ご自身が書いた一つの文書の中で受動態をいくつ使っているかを数えてみてください.筆者は,一つの文書がほとんど受動態の文で書かれている開発文書を読んだ経験があります.あいまいな個所が多く,分かりくい文書でした.

 なぜ,受動態を多用するソフトウェア開発文書を書くのでしょうか.おそらく,ソフトウェア開発では,システムやプログラムやユーザなどの異なる視点で対象を表現する必要があることが,遠因になっているのではないでしょうか.ソフトウェア開発文書は,一つの文書の中でも,システムを対象として記述する個所もあれば,プログラムを対象とする個所もあります.そのたびに,書き手は,どこに視点を置いて,何を主題として書くべきかを意識しなければなりません.書く力が不足すると,視点がシステム,プログラム,ユーザなどと移動するうちに,主題があいまいになり,記述に自信が持てないままに,あいまいに記述しやすい受動態の表現に甘えてしまうことになるのでしょう.ソフトウェア開発の分野には受動態で書く癖がついてしまっている人が多い気がしています.

 ソフトウェア開発文書を書く立場の方は,特に記述の対象は何かを意識した表現を心がけてください.そのための一つの方法として,受動態を使わないことを意識していただきたいと思います.動作するのは,開発の対象物なのか,開発対象を取り巻く周辺の部分なのか,誰が(何が)その動作をするのか,させるのか,こういったことを明らかにすることが,作業を正確に実施して,それを明確に表現することになります.あいまいな表現に頼らず明確に書くことは,自身の作業に自信と責任を持つことにつながります.

組み込みキャッチアップ

お知らせ 一覧を見る

電子書籍の最新刊! FPGAマガジン No.12『ARMコアFPGA×Linux初体験』好評発売中

FPGAマガジン No.11『性能UP! アルゴリズム×手仕上げHDL』好評発売中! PDF版もあります

PICK UP用語

EV(電気自動車)

関連記事

EnOcean

関連記事

Android

関連記事

ニュース 一覧を見る
Tech Villageブログ

渡辺のぼるのロボコン・プロモータ日記

2年ぶりのブログ更新w

2016年10月 9日

Hamana Project

Hamana-8最終打ち上げ報告(その2)

2012年6月26日