ドキュメンテーションで注意すべき5つのポイント

僕は社会人1年目より10年程度、IT系コンサルティング会社で働いていたのですが、その中で一般的な社会人の方より多くの資料を作ってきたのではないかと思っています。

もちろん、上司にもクライアントにも沢山のダメ出しをもらってもきました、、

そんな僕が、ドキュメンテーションする上で注意してきた5つのポイントを本日はご紹介したいと思います。

もちろん、今回紹介する以外にも大切なポイントはあると思いますが、
まずはコアとなる部分はコレだ!と思っているものです。

スポンサーリンク
レクタングル広告(大)

はじめに

突然ですが、あなたは文章を書くとき、何を考えますか?

  • 自分の考えていることを相手に伝えたい!

それも一つだとは思います。

但し、一番重要な事ではないと僕は考えています。

  • 重要なのは相手に何かしてほしい!

これが、ドキュメンテーションの肝だと思ってます。

分かりやすい文章作成のポイント

前述のキモを理解した上で、早速ですが5つの注意点を紹介します。

ポイント1 誰に読ませたい文章なのかを意識する

文章は誰かに読んでもらうためにあります。

相手の立場にたち、適切な言葉遣いや、単語選び、文章量を心がけましょう。

変に難しい言葉を使いすぎたり、悪戯に長い文章は避けるべきです。

引用:池上彰 「伝える力」より

「難しいことも簡単に」書く、話す

私が記者として訓練を受けたときは、「中学生にもわかる原稿を書け」と指導されたものです。新聞の新聞記者も、同じことを言われています。

(中略)難しく書けば(言えば)、立派なことを書いた(言った)気になるのは、勘違いも勘違いも甚だしいのですね。難しいことでも簡単に書いたり、話したりすることこそ、実は難しく、高度な能力なのです。難しいことを易しく表現したからといって、中身自体の質が高かれければ、中身が色あせることはないのです。

ポイント2 一番最初と最後に結論を述べる

長い文章を書くときは文章の段落ごと、または文章全体の最初に、言いたいことの要約を書いた方がわかりやすいです。

出だしを読めば、その文章或いは、段落に何が書かれているのか分かるようにするのです。
出だしの結論から続く、その後の文章は結論の補足や理由説明につとめます。
仮に読み手が最初の一文だけ読んで、貴方の言いたいことを理解してくれれば、後に続く文章の意味も理解しやすくなります。

たしか、バーバラ・ミント 「考える技術・書く技術」で読んだと思うのですが、以下のような事が書いてあったと記憶しています。

人は話を聞くときや、文章を読んでいるとき、潜在的に先読みをしている。なので、何がいいたいかわからない話や、どこまで続くかわからない話を聞いていると「非常に疲れる」。
そのため、「先に結論を述べる」事や、「言いたいことは3点です」などを宣言することによって、「何が言いたいかや」、「全体の話の中で、
どれくらい進んでいるか」を推測しやすくすることが大事になります。

ポイント3 できるだけ文章を短く区切る

  • わかりにくい文章

「ワードによる文章作成は、文字を手で直接書く必要なく、ボタン一つで簡単に打ててしまうので、非常に便利ですが、その反面、文章に抜け落ちなどのミスが多いです。」

  • わかりやすい文章

「ワードによる文章作成は、文字を手で直接書く必要なく、ボタン一つで文字が打つことができ、便利です。

しかし、その反面、文章に抜け落ちやミスが多いです。」

文章を区切るだけでわかりやすくなりますよね?

ポイント4 書き終えたら文章を一度声に出して読む

自分では細かいところまで気を使って文章を書いているつもりでも、読み直すと意外とミスが多いもの。

誤字だったり、文字が抜け落ちていたり、意味不明だったり、大きなミスをしてしまうことも、よくある話です。

出来上がった文章は一度声に出しながら、必ず読みましょう。

そうすることで誤字や文字の抜け落ちの確認だけでなく、文章全体の読みやすさも、知ることができます。

補足:その資料をつかって人に説明する時をシミュレーション

資料を作ったあと、説明するときになって初めて、資料のつくりの悪さを感じることはありませんか?

それを解消するために、説明シミュレーションを行うことで誤字脱字だけでなく、「資料の構成・並び順」や、「文章のわかりやすさ」をチェックできます。

ポイント5 上手な文章をまねする

今までまとめたことを、意識しながら書けば、ある程度は読みやすく、
分かりやすい文章にはなるとは思います。
しかし、もっと面白い文章だったりだとか、より高度な技術も求めたいと考えている方も多いと思います。

そこでそういった技術を身につけたい人には、上手い人の文章をまねすることをお勧めします。

本日はドキュメンテーションスキルについて紹介しました。

社会人としての基礎スキルについては、非常に興味があるテーマなので今後も紹介していきたいと思います。

最後まで読んでいただき、ありがとうございました。

スポンサーリンク
レクタングル広告(大)
レクタングル広告(大)

シェアする

  • このエントリーをはてなブックマークに追加

フォローする