見出し画像

ドキュメント品質、文章の品質

ソフトウェア開発に限った話ではないと思うのですが、基本的に『仕事』と言うものは、常に何か

 課題

を解決するものだと私は考えています。コピーを取る作業1つ取っても、コピーを取らなければ何かの課題が解決できない事情があるからで、別にコピーじゃなくても解決できるなら、無理にコピーを取る必要はないはずです。

そうやって考えていくと、一つひとつの作業って、どんな些細なことでも意味があって、その意味や目的が果たせる形で作業しないと、ただ言われたことを言われるがまま何も考えずに作業しているだけでは、課題そのものを解決できていないケースだって起こりうるわけです。

先の例でいえば、「コピーを取る」と言う行為にしても、ただの雑用と感じるかもしれませんが、

 「来客されるお客さまにご理解いただくため」

と言う目的があった場合、おそらくただコピーを取ればいいと言うわけではないかもしれません。プロジェクター等で見せるだけでもご理解いただくことは可能です。それをあえてコピーにすると言う時点で『持ち帰っていただく』と言う付帯効果もついてくることが伺えます。

来客される方の肩書などがわかれば、『持ち帰って、上司等に提出する』ことも想定に加えていいかも知れません。

そうやって考えていくと、

 ・配色(色の濃さ)
 ・ステーブルの有無や位置
 ・部数

なども具体的にイメージしなければならなくなります。ただの「これ、コピーとっといて」なんて雑な依頼であったとしても、そこからどんなビジネスになっていくのか、どんな課題解決をしていくことになるのか想像するだけで、様々な検討ができると言うものです。

そんなビジネスの原理原則がある中、意外と仕事(課題解決)において重要度の高い成果物「文書(ドキュメント)」については、やたらと軽視しているビジネスパーソンがものすごく多いように感じます。

私が現在所属している会社がたまたまそうだった…と言うだけなのでしょうか。ユーザー企業などと協働する際にも、どうも違和感を感じるあたり、私の身の回りだけではない気がするのです。

「文書」の重要性

よく大量の文書を作成すると、「長い」「読みづらい」と言った文書に関するクレームを耳にしますが、文章とは情報であり、情報は適切に相手に伝わらなければ意味がないものです。ですからもし、どうしても長くしなければならない理由があったのだとすると、それは

 • 読み手の読解力が低い
 • 知識が乏しい

等によって、あえて係り受けを複雑にしなければならない場合、である可能性を気にした方がいいかもしれません。なんでもかんでも短ければいいと言うものではないのです。

「言葉」は長ければ長いほど、冗長的になりがちで、ムダな贅肉がつく可能性がありますが、短ければ短いほど、情報量が少なくなり、読み手の読解力が求められると言うことも併せて認識しておかなくてはなりません。

たとえば

 「まず最初に、言っておきたいことがあります。」

という言葉があるとします。「まず」とは変換すると「先ず」となり、「先に」「最初に」という意味になりますので、二重となっているため、無駄です。この場合、

 「最初に、言っておきたいことがあります。」

とするのが正しい表現となります。

このように、「国語」について細かいことを言えば、いくらでも言葉の贅肉を省くことは可能ですが、こうした国語的な表現の制約を除いた場合、本当に必要な情報まで削り落としてしまうと、読み手は「解釈の自由」を行う権利を得てしまい、属人的なプロセスが介入する余地を与えることになってしまいます。

それでは、文章自体の目的を果たせず、本末転倒です。


文章の品質

文章の品質には段階(レベル)があり、それは読み手の読解力や予備知識の量によって、内容が異ならなければならない、と言うことを一方で肝に銘じながら、以下の点を意識して作成するようにしましょう。

最低限求められるのは、大きく分けると次の要素です。

・正しい文章を書く
・無駄がなく、読みやすい文章を書く
・文章そのものの価値を高める

書き手が伝えたい内容が、読み手の読解力によって左右されるようでは、正しい文章とは言えません。まずは読みやすさは後回しにして、誰が読んでも同じ解釈ができる文章を心掛けましょう。

この基礎ができていないまま、読みやすさだけを追求しても、結局

 ただ読みやすいだけの駄作

にしかなりません。「読みやすければ駄作でもいいのか?」と言うと、ダメに決まってます。文章そのものの目的は「読み手に正確に伝わること」です。伝えたいことが伝わらないと言うことは、コミュニケーションとして成立していないということです。それは、作成した文章自体に目的を果たすだけの価値がないということでもあります。

「無駄がなく、読みやすい文章を書く」のは、文書として最低限の役割・目的を果たせるようになった後にすることです。もちろん、この段階まで考えられるようになれば、それなりにチーム内で重宝されているのではないでしょうか。そもそも、この段階にまで至らない人が多すぎるのです。

特にIT業界は、プログラミングにばかり傾倒して、文章作成能力が低い人が目立つように見えます。結局…日本語で書かれた仕様書や設計書等を元にプログラミングしていくはずなので、普通にドキュメントを「書く」「読む」ができないという時点で、不良/欠陥の混入率が上昇し、無用なトラブルを招くだけなのですが、そのことに気付いている人は決して多くはないように感じます。

「文章そのものの価値を高める」とは、言い換えれば「必ず正確に伝わる内容や表現であること」とも言えます。こねくり回して、読みにくい文章になってしまったものなどは、価値そのものが低下してしまっている…ということでもあります。

わかりやすいところで、二重否定などがそうですね。

 「弱点を攻めれば、勝てないわけではありません。」

わざと、わかりにくくしているのかもしれませんが、わざとにせよ、読み手に変な誤解を与える可能性を残した時点で、ビジネス文書としてはアウトです。単純に

 「弱点を攻めれば、勝てます。」

と表現すればいいだけです。100%と断言したくないなら

 「弱点を攻めれば、勝てる可能性がでてきます。」

とすればいいでしょう。どちらにしても、二重否定をわざわざ使う必要性は皆無です。

画像1

コミュニケーション…中でも"会話"のたとえに、「言葉のキャッチボール」という言い回しがありますが、そうだとすると文章の駄作と言うのは、ただの暴投と同じということになります。

取りやすいボールを放る前に、まずはきちんと相手が受け取れるボールを放りましょう。当然、設計書の書き方1つとっても同様のことが言えるわけです。


正しい文章を書く

自身の中でチェックすべき観点は次の通りです。

① 主語と述語が正しく対応しているか
② 「なぜなら」や「もし」などを正しい言葉で受けているか
③ 正しい係り受けになっているか
④ 用語は統一しているか
⑤ 時制は正しいか

ひとえに「正しい文章」といいますが、正しい文章は何が「正しい」のかと言うと、細かいことを言い出せばキリがありません。アメリカの文章作法に「エコノミック・アテンション」というものがあります。"手間をかけずに読んでもらう"ために注意することを指します。

読み手を疲れさせずに自然と理解してもらえる、読んでいて「煩わしくない文章」。そのような文章からは「品の良さ」を感じ取ることができます。表現力・演出力はまず置いておいて、正しいことばづかい、リズム感、見た目を整えることによって、文章をさらに「品の良い文章」へと磨いていく作業が大切になるのではないでしょうか。

なかでも、見逃しがちで注意すべきは、「時制は正しいか」です。

もう少しわかりやすく言うと、

 過去(現在)の出来事を現在形(過去形)で書いてないか

と言うことです。報告書等にしてもそうですが、現在注意すべき点を過去形にしてしまうと、「既に終わったこと」と勘違いされて、読み飛ばされてしまう可能性があります。正しい時制は、正しい判断を導くために、地味に重要だったりします。

日本語には、英語のように時制が存在しません。単純表現だけを見てみると、それが未来の話なのか現在の話なのか、現在を指す言葉なのか現在進行形を指す言葉なのか、過去完了を示しているのか過去の出来事を示しているのか、全くわからない文章と言うものは多々あります。

これは文章を短くしすぎたことによって起きる弊害でもよく見かけます。たとえば

 「私はテニスをします。」

という言葉は未来の決意の話でしょうか?それとも、今現在におこなう行動の話でしょうか?

 「私は英語のレッスンを受けています。」

という言葉は、現在の状態を指しているのでしょうか?それとも現在進行形の作業を表しているのでしょうか?

こうした時制については、それがどのタイミングの表現であるかを明確にしようとすると、どうしてもそれを説明するだけの文字数が増えることになります。これを「長いから」「無駄だから」と言って省いてしまうと、当然ながら時系列に読み解くことが困難になり、読み手の読解力を超えた時点で、正確に伝える…という主命題を疎かにしてしまうことになりかねません。


無駄がなく、読みやすい文章を書く

⑥ 一文が長くなっていないか
⑦ わかりやすい語順になっているか
⑧ 説明なしで専門的なIT用語を使っていないか
⑨ 特定の企業や組織だけで通用する用語を使っていないか
⑩ 逆説の接続詞を繰り返していないか
⑪ 二重否定をしていないか
⑫ 代名詞が指し示す内容が明確か
⑬ 受身形を極力使わないようにしているか
⑭ 「…だ」、「…だ」など、同じ語尾を続けていないか
⑮ 1つの文中で同じ言葉を繰り返し使っていないか
⑯ 助詞の「の」を3つ以上つなげていないか

ここまで来ると、日本語…というより、国語の世界に入ってきますね。

しかし、「煩わしいから無視していいか?」と言うとそれは誤りです。読み手の立場に立てば、大きなビジネスという枠で考えれば、これらのポイントが押さえられていない文章を読んだ時点で、おそらくは誤解を生み、大きなトラブルを誘発してしまうことでしょう。

文章力に自信がない人は、特に「代名詞が指し示す内容が明確か」と言う点を気を付けましょう。厳密には日本語の中に存在はしませんが、最も大きな問題を招きやすいものに『関係代名詞』があります。日本語では"こそあど言葉"などがこれに相当します。

会話の中で頻繁に「あれ」や「それ」と言った言葉を乱用してはいないでしょうか。関係代名詞とは、接続詞と代名詞の働きを併せ持つ品詞です。厳密には日本語の中にはそういった品詞は見当たりませんが、目的が似た言葉は存在します。それが「指示語」です。

画像2

関係代名詞には、あらかじめ「あれ」や「それ」の示すものが、聞き手との間で共有されていなければならないと言う条件があります。文章においては、「あれ」と表現される以前に、対象を明確化しておく必要があるということです。こうした制約事項を無視して、日常会話と同じレベルで

 「あー、"あれ"のことっすね。了解っす」

などと言っていると、互いの認識がずれている場合に、後々大きな問題となりかねません。


文章そのものの価値を高める

ここから先は、いわゆる「上品な文章」であるための努力となるため、必ずしも必須と言うわけではありません。

⑰ 途中で疑問形の文章を入れて読み手の興味を引き付けているか
⑱ 事例やエピソードなどを書いて具体的に説明しているか
⑲ 数字やデータを盛り込んで説得力や信憑性を高めているか
⑳ 単なる事実の羅列に留めず意義や理由を説明しているか

プレゼンテーションや提案、教育などではこう言ったバックボーンがないと、説得力等がついてこない…と言うものです。コンサルティング業務や提案活動などでは、常識とされているチェック事項となります。ビジネス文書(質問表や報告書、設計書など)にはあまり使う機会はありませんが、たとえばメールなどでは使う機会があるかも知れません。

いわゆる、フロントエンドのエンジニアを目指すのであれば、頭の片隅に入れておいた方がいいかも知れません。

これらの事項を無視して、延々と情報を垂れ流すだけの会議や説明会、プレゼンなどは、ひどく退屈なものとなることでしょう。特に⑱~⑳は具体化の重要性を指し示していますが、これらがないということは聞き手、読み手にとって、現実味がわかないことを意味します。

たとえば

 「ほとんどの人がやっています」
 「ほぼうまくいくでしょう」
 「仕事はだいたい終わりました」

というより、

 「3人に1人の人がやっています」
 「90%の確率で上手くいくでしょう」
 「10機能のうち、7機能が完了しました」

と言った方が、より信憑性が増すというものです。

現実感を喪失したままでは、興味がわきませんし、興味がわかなければ、聞く言葉、読む内容はすべてただの記号や念仏にしか聞こえませんし、見えません。意味のある"情報"として頭の中に入ってこないのです。

ただの自己満足として文章を書きたかっただけなのか、それとも相手に知ってほしいと思って文章を書いているのか、その文章自体の価値を測る部分がここにあると考えてください。

いただいたサポートは、全額本noteへの執筆…記載活動、およびそのための情報収集活動に使わせていただきます。