システムエンジニアに限ったことではないのかもしれませんが、(私も含め) 文章が苦手な人が特に多いようです。
作成された設計書やマニュアルに「保存を行う」とか「取得を行う」といった言葉が出てくるのをよく見かけます。
以前お世話になった企業の部長から指摘されるまでは全然気にしていなかったのですが、聞いたときはかなりの衝撃でした・・・。
自分も文章に自信がなかったので、今でもその部長には感謝しています。
もし知らない人がいたら、意識して実践してみてください。
特にお客様向けのマニュアルや議事録などを作成する場合は気を付けた方が良いですよ。
違和感
以下の処理記述は、設計書等でたまに見かける記述なのですが、皆さんは違和感を感じますか？
・ 会員情報取得を行う ・ 会員情報入力チェックを行う ・ 会員情報登録を行う ・ 会員情報再取得を行う ・ 会員情報表示を行う
同じ言葉が並んでいるのも原因のひとつなのですが、設計書にはひとつひとつの処理を並べる必要があるため「～する」という言葉が続くのは大きな問題ではありません。
違和感の正体
違和感の正体は、「取得する、行う」、「チェックする、行う」、「登録する、行う」などふたつ以上の動詞が並んでいるところにあります。
細かい分類は本題とは関係ないので、興味があれば調べてみてください。(大雑把です)
「行う」だけでなく、「登録を実施する」とか「削除を実行する」も良く使われます。
「登録作業を実行する」とか「ボタン押下を行う」など、普通に見ても違和感のある文章が使われていることもあります。
確かに、プログラミングの設計書では、「会員情報取得」や「会員情報入力チェック」、「会員情報登録」、「会員情報再取得」などが処理の名前となっていることが多く、そのまま文章に使うと『「○○取得」を行う』、『「○○チェック」を行う』となります。
一般の人から見るとなんのこっちゃという文章も、システム開発の設計書には記述されていることが結構あります。
違和感の改善
では実際に見やすく書くにはどうしたらよいのか、実際に記載している方法も合わせて紹介します。
私も文章は苦手なので、自分なりの書き方を勉強してください。
点数は個人的に思う点数です。根拠はありません。
処理名を囲う
違和感は減りませんが、言いたいことが少し通じます。(30点)
・ 「会員情報取得」を行う ・ 「会員情報入力チェック」を行う ・ 「会員情報登録」を行う ・ 「会員情報再取得」を行う ・ 「会員情報表示」を行う
処理名だけにしてしまう
変に「行う」を付けるより全然見やすい。(50点)
・ 会員情報取得 ・ 会員情報入力チェック ・ 会員情報登録 ・ 会員情報再取得 ・ 会員情報表示
ひとつの動詞で記述する
文章として何となく自然。(70点)
・ 会員情報を取得する ・ 会員情報の入力内容をチェックする ・ 会員情報を登録する ・ 会員情報を再取得する ・ 会員情報を表示する
処理名 + 説明
設計書のフォーマットによりますが、「処理名」と「説明」は別々に記述すると見やすくなります。(80点)
・ 会員情報取得 会員情報を取得する ・ 会員情報入力チェック 会員情報の入力内容をチェックする ・ 会員情報登録 会員情報を登録する ・ 会員情報再取得 会員情報を再取得する ・ 会員情報表示 会員情報を表示する
自由度の高いフォーマットであればあるほど、作成者の文章能力が表れてしまいますので、読みやすさ第一が良いと思います。
重要
特に注意したいのがお客様向けの「マニュアル」や「議事録」です。
お客様には処理名はあまり関係ないので「〇〇を取得する」、「○○を確認する」といったような記載にしたほうが読みやすいです。
「チェックする」も「確認する」にした方が良いでしょうか。
ちまたでは・・・
お客様に指摘されてからは、Web 上で公開されているニュースなどでも「行う」を使っている人が意外と多いことに気づきます。
もちろん正しい使い方をされていることもあるのですが、一度気になると変に違和感を感じます。
まとめ
「登録を行う」、「作業を行う」等、動詞がふたつ以上使われると違和感があるという話でした。
システムエンジニアは理系上がりの人が多く、文章が苦手な人が多いようです。
私は私立文系ですが、語学の勉強は全くしてこなかったので文章はかなり苦手です。
このブログでも 100点の文章は書けませんが、80点くらいは取れるようにがんばりたいと思います。