SE（システムエンジニア）の方の中には、文章を書くのが苦手な方も多いのではないでしょうか。

システム開発が主な仕事内容であるSEといっても、設計書や議事録、報告書など、様々なドキュメントを作る必要があります。
文章を書かなくてもよさそうだからSEになったのに、入社してから「こんなはずじゃなかった……」と後悔している方もいるかもしれません。

しかし、心配はいりません。文章力は生まれ持っての才能ではなく、努力次第で向上させることができるのです。
この記事では、分かりにくいドキュメントの特徴と、その解決策をまとめました。

分かりにくいドキュメントの特徴

何を書いているのか分からない。間違ったことは書いていないけど、なぜか読む気にならない。そんなドキュメントには、共通する特徴があります。

特に多いのは、以下の3つです。

何を伝えたいのかが分からない

SEの仕事で作成するドキュメントには、必ず目的があります。小説やエッセイのように、「解釈は読者の皆さんに委ねます」といったことは起こらないはず。
にもかかわらず、「結局、何が言いたいの？」と首をひねってしまうようなドキュメントも少なくありません。
具体的には、以下のようなものが挙げられます。

• 開発要件が網羅されておらず、細かい仕様はその都度口頭で確認しなければならない設計書
• 出席者の発言を羅列しているだけで、会議で何が決まったのか分からない議事録
• ミスの言い訳ばかりに終止し、改善策が書かれていないトラブル報告書

こうしたドキュメントは、作成した本人ですら、「なぜ自分がこのドキュメントを作ったのか」分かっていない場合がほとんどです。

昔からの慣習で作っただけかもしれないし、上司からの命令で仕方なく作ったのかもしれない。
あるいは、自発的に取り組んでいたとしても、ドキュメントの作り方を知らないため、的外れな成果物ができあがってしまっている可能性もあるでしょう。

論理的でない

ドキュメントの目的がはっきりしていても、そこに至るまでの過程がなければ、読む人を納得させることはできません。
例えば、あなたがクライアントだとして、以下の提案書を読んでシステムを導入したいと思うでしょうか？

「御社の同業他社の多くは、すでにERPパッケージを導入して業務効率化に成功しています」

「そのため、御社にも弊社のERPパッケージの導入を提案いたします」

他社も導入しているからというのは、高額なERPパッケージを導入する理由としては弱いでしょう。

仮に導入するとしても、なぜあなたの会社のパッケージなのか、他社のパッケージでは駄目なのか、その根拠も説明できていません。

このような「論理の飛躍」があるドキュメントでは、読み手に疑問を抱かれてしまいます。

文章そのものが読みにくい

ドキュメントの目的が明確で、論理も間違っていない。それなのに何故か読んでもらえないドキュメントは、文章そのものが読みづらい可能性があります

もちろん、プロの小説家のように美しい文章を書く必要はありません。しかし、社会人の書く文章として、最低限のルールは守る必要があります。
あなたが書いたドキュメントを読み返してみて、以下のような問題点がないか、一度確認してみてください。

• 一文が長い。読点（、）が少ない
• あいまいな表現が多い（～と思われる、～かもしれない）
• 冗長な言い回しが多い（～ないわけではない）
• 指示語が多い（この、その）
• 語尾が連続している

解決策

では、どうすれば分かりやすいドキュメントが作れるようになるのでしょうか？　それぞれ解説します。

ドキュメントを作成する目的を考える

なぜ自分が、このドキュメントを作成する必要があるのか。
実際に作業に取りかかる前に、まずはそのことを考えてみてください。

例えばトラブル報告書なら、なぜトラブルが発生したのか、今後トラブルを発生させないためにはどのような対策をすればよいのかを論理的に書く必要があります。

そう考えれば、「自分は悪くない」と言い訳だけを書いても意味がないと分かるでしょう。

また、クライアントに提出するトラブル報告書だとすると、淡々とトラブルの原因と対策だけを書くだけでは、クライアントの心象を悪くするかもしれません。

最初に謝罪の一文を入れるなど、読む人の立場に立ってドキュメントの書き方を変えるのが重要です。

文章の型をマスターする

ドキュメントを読んだ人に納得してもらうためには、文章に論理性がなければいけません。

先に挙げた提案書の例であれば、「御社がERPパッケージを導入することでどのようなメリットがあるのか」、「他社でなく、自社のERPパッケージを勧める理由は何か」を説明する必要があります。

前者の場合、ERPパッケージを導入することで削減できる時間やコスト。後者の場合、パッケージの価格や導入までの期間などを具体的な数字で示すことができれば、説得力が増すでしょう。

論理の展開の仕方にも、いくつかのテンプレートがあります。

よく使われるのは、「起・承・転・結」、「序論・本論・結論」、「結論・理由」など。

提案書であれば、クライアントの興味を惹きつけるために「結論・理由」の型を使う。長文になる市場調査報告書であれば「序論・本論・結論」にするなど、ドキュメントの種類によって使い分けるとよいでしょう。

たくさん読んで、たくさん書く

一文の長さがちょうどよかったり、読んでいてリズムが心地よかったりする文章を書くための一番の近道は、お手本になる文章を見つけることです。

多くの本を読んで、そこに書かれている表現や単語を使ってドキュメントを書く。
最初は誰かの真似でも構いません。数をこなしていくうちに、次第に書きやすい文体が身についていくはずです。

ただし、お手本にするのであれば、インターネットの記事よりも、紙の本をおすすめします。
紙の本が作られるまでには、編集者や校閲者など、多くの人のチェックが入っています。全ての本が参考になるわけではありませんが、個人が公開している場合も多いインターネットの記事よりは、総じて文章が洗練されているといえるでしょう。

まとめ

• ドキュメントを作成する目的を考える
• 文章の型をマスターする
• 多くの本を読み、ひたすら実践する

文章を書くのが苦手と思うSEが多いからこそ、分かりやすいドキュメントが作成できれば、あなたの実力を上司やクライアントにアピールすることができます。
この記事で解説した内容を参考に、ぜひ文章力の向上に取り組んでみてください。