プログラミング 仕事

【仕事】分かりやすい文書で読み手を救う【プログラミング】

投稿日:2019年11月1日 更新日:

今回は、文書の書き方に関する記事となります。文書作成は、特に業界問わず、色んな仕事に通用するスキルになると思います。

今回はプログラミング関係で、ソフトウェアの仕様書を題材にします。


使うべき「アプリ」

いきなりですが、文書作成において使うべきアプリケーションを挙げます。

  1. Microsoft Office Word
  2. Microsoft Office Powerpoint

この2つの内のどれかを使うと良いです。もしくは、上記2つのアプリで原文を作り、PDFに変換して配るというのも便利です。

Excelは避けましょう

文書を作る時、作成者目線で作りやすいアプリはExcelだと思います。しかし、他人にも見てもらう文書を作る場合では特に、Excelは避けたいです。

理由はこちら

  • 小さい文字でも作れてしまうので、スクリーンに映した時見づらいことが多い
  • 印刷した時、テキストの折り返し箇所やオートシェイプの位置が若干ずれる
  • ページの概念を意識せず作れてしまうので、読む順番がトリッキーになりがち

文書やプレゼンテーションの作り方

ここからは、やや概念的な話に入っていきます。

目次

文章を作る前に、下の箇条書きのようにして、情報を階層構造に分けていきましょう。いわゆる「目次」というものに相当します。

  • 全体像
    1. 中項目A
      • 「aaaaaaaaaa事例」
      • 「bbbbbbbbb事例」
    2. 中項目B
      • 「詳細CCCCCC」
      • 「詳細DDDDDD」

WordにしてもPowerpointにしても、目次は極力付けるようにしてください。

これは、文書の「全体像」を相手に伝えるためです。

文章

まず、情報量を削ってでも、分かりやすく書くように心がけて欲しいです。

気を付けるべきことを数点ピックアップします。

  • 一文一義 一つの文に対して、一つの内容、意味だけを付加してください。
  • 具体性と抽象性のバランス 具体的な情報を伝える場合は、その全体像とかテーマなどの抽象的な情報を前もって書きましょう。
  • 一つのページで、一定量の説明を「完結」しましょう。

Powerpointを使うと、上記3点を意識せざるを得なくなります。それゆえ、資料やマニュアル類はPowerpointで作ることをおすすめします。今どきは、文書をPC画面上でのみ閲覧することが多いと思います。その場合、Powerpointのような横長スタイルの方がしっくりきます。

なお、Wordでも「印刷の向き」という項目を触れば、横長方向の文書を作ることが可能です。場合によっては、この使い方を取り入れるのも良いと思います。


今回はここまで。内容が「広く浅く」になっていることは自覚があります。ニーズがありそうなら、もう少しテーマを絞り込み、より具体的な話を書いていくかもしれません。

それでは。

-プログラミング, 仕事

執筆者:

pagetop