見出し画像

リモートワークにおいてドキュメントを書くときに気にしていること

こちらは緊急事態宣言 アドベントカレンダーの38日目の記事です。


リモートワーク下では自分の意見を文章で言語化する機会が多くなってくると思います。なのでドキュメントを書く際に意識すべき点を以下の本を読んで勉強したので自分が気になった点をピックアップしてみました。

こちらの本は技術文章を分かりやすく伝えるための本ですが、技術文書に限らず応用できる内容だったので、その点をあげてみました。

誰に向けて書くか?読者がどうなってほしいか?を明確にする

誰に向けての記事なのか、前提知識は何なのかを文章の冒頭にて明確にしておくことで、読者は自分が対象なのか、事前に必要な知識は何なのかが分かります。また執筆者は前提知識の説明を文章でわざわざ書かなくてもよくなるので伝えたいことに文章を集中させることができます。

また、「この文章を読むとnoteに文章を投稿する方法が身につきます」といった一言を冒頭に書くだけで、読者自身がこの文章は自分に必要な情報なのかをすぐに判断できます。

具体的な例を示す

何か物事を説明する際は実際に具体的な例を示すと読者の理解が深まります。例えば以下のように実際にOKとNGのパターンを示すことによって何を伝えたいかがより分かるようになります。

「それ」「あれ」「この」といった表現を多様すると、読者は「それってなんのことだろう?」と迷うことがあるので注意が必要です。

NG:
ミーティングをする際は、議事録をとることが大事です。それをすることによって不参加の人も、その内容を把握することができます。

OK:   
ミーティングをする際は、議事録をとることが大事です。議事録をとることによって不参加の人も、ミーティングの内容を把握することができます。

伝えたいことは一つに絞る

人は文章を読みながらでも記憶が薄れていくものと考えて、伝えたいことを簡潔に書くことを意識します。「結局この文章でいいたいことって何だっけ?」とならないように一つの段落では伝えたい内容は一つに絞ります。

時間が経てば変わる情報を意識する

文章の内容が数年後も継続している事実かどうかは分からないため、執筆をした年月日が分かるようにします。また、記載している事実はどこからやってきた情報なのかをそえることでより読者がいつ文章を読むかを想定できます。例えば

リモートワークを実施している企業は東京だけで 26% です。
(2020/4/8時点)
参考: https://xtech.nikkei.com/atcl/nxt/news/18/07548/

事実がわからない場合はぼやかさない

「おそらく」「らしい」「やや」など不明確になるような表現を避けます。読者は文章を読んだ時に、「断言できないということは何か例外があるのかな?」と疑いの目で見始めるため、文章の説得力が無くなってしまうためです。

不明確な情報がある場合は、丁寧に調べるか、「こういう理由で断言できない」という情報を添えてあげるとよいです。

まとめ

以上、文章を書く上で気にすることを上げてみました。自分もなかなか文章を書くのが苦手なのですが、こうやって定期的にnoteを書いたりして文章力を上げていければと思います。ゆくゆくは技術書典とかで本を出版してみたいものです..! ではよいドキュメントライフを!

この記事が気に入ったら、サポートをしてみませんか?
気軽にクリエイターの支援と、記事のオススメができます!
🤗
10
フルリモートで開発をしながら子育て奮闘中のエンジニアです。コーヒーとコンテナ技術とReactが好きです。

こちらでもピックアップされています

DevLOVEのノート
DevLOVEのノート
  • 126本

開発現場と越境する人のためのコミュニティDevLOVEのNoteです。イベント告知、案内、関係者のnoteを投稿していきます。

コメントを投稿するには、 ログイン または 会員登録 をする必要があります。