さらば、翻訳調の文章! 技術者向け校正ルール:誰にでも分かるSEのための文章術(8)(2/2 ページ)
「提案書」や「要件定義書」は書くのが難しい。読む人がITの専門家ではないからだ。専門用語を使わず、高度な内容を的確に伝えるにはどうすればいいか。「提案書」「要件定義書」の書き方を通じて、「誰にでも伝わる」文章術を伝授する。
漢字を多用する文章は読みにくい。平仮名にできるものは平仮名に
技術者には、平仮名表記が一般的な語句を漢字で書いてしまう傾向があります。ワープロソフトなどの入力変換で簡単に漢字変換できるため、つい漢字を多用してしまうのではないでしょうか。
平仮名で書かれるべき語句が漢字になっていると、文章が非常に読みにくくなります。変換機能に頼らず、意識的に漢字と平仮名を使い分けなければなりません。次のような言葉は、平仮名で記述しましょう。
データを消去出来る → データを消去できる
使用可能な事を確認する → 使用可能なことを確認する
予めデータを用意しておく → あらかじめデータを用意しておく
一旦データを保存する → いったんデータを保存する
先ず電源を切ってください → まず電源を切ってください
僅かな違いでも致命的である → わずかな違いでも致命的である
殆ど同時に完了した → ほとんど同時に完了した
各々のデータを検証する → おのおののデータを検証する
全てのファイルを削除する → すべてのファイルを削除する
この作業は既に完了した → この作業はすでに完了した
尚、詳細は別紙を参照 → なお、詳細は別紙を参照
A又はB → AまたはB
A或いはB → AあるいはB
A及びB→AおよびB
A且つB → AかつB
使用する上で注意すべき点 → 使用するうえで注意すべき点
携帯電話やノートパソコン等である → 携帯電話やノートパソコンなどである
電源を切って下さい → 電源を切ってください
数値が変化し易い → 数値が変化しやすい
温度の変化は無い → 温度の変化はない
データを変換する為に → データを変換するために
データを変換する時に → データを変換するときに
データを書き込む様に設定する → データを書き込むように設定する
1分毎にブザー音を鳴らす → 1分ごとにブザー音を鳴らす
3分程停止させる → 3分ほど停止させる
宜しくお願い致します → よろしくお願いいたします
特に、上記2つの「出来る」「事」は、多くの人が漢字変換がちです。「する事が出来る」という表現は、シンプルに「できる」と修正しましょう。
難しい言葉をできるだけ使わない
簡単な言葉があるにもかかわらず、難しい言葉を使っている文章もあります。できるだけ簡単な言葉を使うようにします。
このソフトウェアを使用すると容易に情報を更新できる。
このソフトウェアを使用すると簡単に情報を更新できる。
この考え方に則ってシステムを開発する。
この考え方に基づいてシステムを開発する。
技術者特有の「方言」を排除する
技術者は、プロジェクトメンバーと電子メールで情報を交換します。電子メールでは、仲間内の気楽な表現や話し言葉をよく使います。その延長線上で、顧客に読んでもらう文章でも仲間内の表現を使ってしまうことがないでしょうか。顧客に提出する文書はビジネス文書です。きちんとした書き言葉を使わなければなりません。
最初にこちらの要求を提示します。
最初に当社の要求を提示いたします。
また、技術者同士だけで通用する俗語や、社内や特定の範囲(グループ内、関連会社の範囲内など)だけで通用する「方言」も使わないようにしましょう。
システムを立ち下げるときの注意点を以下に記述する。
システムを終了させるときの注意点を以下に記述する。
この期間を、作成済みのプログラムの虫取りにあてる。
この期間を、作成済みのプログラムのデバッグにあてる。
表記の揺れと音引きに注意する
表記の揺れ
同一の語句を少しだけ異なった表記で記述することを、「表記の揺れ」と呼びます。下記のようなものが「表記の揺れ」です。
- インターフェース
- インタフェース
- インターフェイス
- インタフェイス
文書中で表記の揺れがあると読みにくいため、どれか1つの表記に統一します。
ただ、どんな表記でもよいというわけではありません。一般に使われている表記を使いましょう。上記の例では、「インターフェイス」を使います。そのほか、次のような表記が一般に使われます。
- ソフトウェア、ソフトウエア→ソフトウェアに統一
- ウィルス、ウイルス→ ウイルスに統一
音引きの問題
表記の揺れの1つに、音引きの問題があります。英語を片仮名にした用語の末尾に“ー”を付けてのばすのが音引きです。IT領域では、通常「コンピュータ」のように末尾をのばしません。そのため技術者は、顧客向けの文書でも同様に表記します。しかし、一般の新聞や雑誌などでは、通常は「コンピューター」と末尾に“ー”を付けます。“ー”を付けない表記は、顧客に違和感を与え、読みにくく感じさせます。
今回の連載では、これまで末尾に“ー”を付けない表記を使ってきました。また、今後も同様の表記を使用します。これは、主要な対象読者である技術者の方に違和感があるだろうと考えるためです。そのため、SEにとって馴染みのある表記(当サイトの標準表記)を使用しています。
ただし、上で説明したように、非IT領域の人が使うのは“ー”を付けた音引きの表記です。顧客向けの文書を執筆する際には、「音引きをした表記」に従うほうがよいでしょう。例えば次のように表記します。
- ユーザ→ユーザー
- サーバ→サーバー
- メモリ→メモリー
- レコーダ→レコーダー
- プリンタ→プリンター
- 光ファイバ→光ファイバー
- セキュリティ→セキュリティー
ただし、一般の表記にも、音引きの例外があります。
- ブラウザー→ブラウザ
- エンジニアー→エンジニア
完成した文書をチェックする
書き終えた文書は、最後に必ずチェックしましょう。表記の揺れチェックには、Microsoft Wordなどワープロソフトの「表記揺れチェック」の機能を利用します。この機能を使えば、自動的に表記の揺れをチェックできます。
表現の詳細は、人手でチェックしなければいけません。まず、記述した本人がチェックし、修正します。次に、できることなら第三者にチェックしてもらいましょう。本人のチェックは甘くなりがちになるからです。第三者のチェックが無理であれば、本人が、自分でチェックする際に、できるかぎり第三者の視点で客観的に厳しく評価するように心掛けなければなりません。
チェックは焦点を絞って行います。例えば、次のように焦点を決めます。
- 用語の表現(専門用語、略語、仲間内の表現、表記の一貫性など)
- 文章の構造や型(第5回「ドキュメントの質を確実に上げる6つの文章作法」で紹介したポイント)
- あいまいな表現(第6回「読みやすい文章の極意は「修飾語」にあり」で紹介したポイント)
- 文体(冗長な表現、翻訳調の表現、プログラム的な発想の表現)
まず1番目の焦点に絞って文書全体をチェックし、次に2番目の焦点に絞って文書全体をチェックするというように、焦点ごとにチェックしていくと、読みやすい文章に仕上げられます。
チェックは、紙に印刷した文書で行っても、画面に表示した文書データで行ってもかまいません。チェックした個所が分かり、チェック前の不適格な表現を(消さずに)残せ、チェック後の適格な表現を書き込めるなら、どちらの方法でもかまいません。ただし、顧客へ紙に印刷した文書を提出するのであれば、印刷した文書でチェックする方がよいでしょう。
著者紹介
谷口 功 (たにぐち いさお)
フリーランスのライター、翻訳家。企業にて、ファクシミリ通信網を使ったデータ通信システム、人工知能、日本語処理関連のソフトウェア開発、マニュアルの執筆などに関わる。退職後、コンピュータ、情報処理、通信関連の書籍の執筆、翻訳、各種マニュアルや各種教材の執筆に携わる。また、通信、コンピュータ関連のメールマガジンの記事、各種雑誌においてインターネット、パソコン関連の記事やコラムなども執筆。コンピュータや通信に関連する漫画の原作を執筆することもある。 主な著作は、『SEのための 図解の技術、文章の技術』(技術評論社)、『ソフト契約と見積りの基本がよ〜くわかる本』『よくわかる最新 通信の基本と仕組み』(秀和システム)、『図解 通信プロトコルのことがわかる本』『入門ビジュアルテクノロジー 通信プロトコルのしくみ』(日本実業出版社)、『図解 ネットワークセキュリティ』『マスタリングTCP/IP IPsec編』[共著](オーム社)など。
- システム開発を成功させたいSEに送る、「文書執筆のおきて」まとめ
- マニュアル執筆が怖くなくなる、12の執筆ポイント
- 「目次」の良し悪しが、すべてのマニュアルの良し悪しを決める
- 知るだけで天地の差が出る、テスト仕様書の必須項目&表現方法
- 「バグ数には興味ないのだよ」――顧客が喜ぶテスト仕様書とは?
- 論理的なプログラムを書くプログラマは、論理的な文章も書けるか?
- 文書ごとに最適な「構成のフレームワーク」は異なる
- さらば、翻訳調の文章! 技術者向け校正ルール
- 専門用語は徹底的に「読み手指向」で書くべし
- 読みやすい文章の極意は「修飾語」にあり
- ドキュメントの質を確実に上げる6つの文章作法
- 「要件定義書のアウトライン作成」完全マニュアル
- 分かりやすい提案書はアウトラインが美しい
- ヒアリング現場で使えるコミュニケーション力
- 開発工程でSEが書く文書の基本
Copyright © ITmedia, Inc. All Rights Reserved.