読者です 読者をやめる 読者になる 読者になる

ぬじろぐ

メモです。議論やコメントは受け付けておりません。当方オタクの女ですので、唐突に腐ったりします。注意。

外部へ向けての説明記事の書き方メモ

日記

外部へ向けての報告書とかまとめ記事の書き方でも人によって上手い下手あるよなと思ったので、必要な要素について。
文章の上手い下手じゃなくて。なんというか、もっとビジネスライクなあれ。
こういうテンプレで作成すればそこそこ見れるものができるんじゃないかなーというメモです。

冒頭

  • 記事を書いているのは誰なのかを示しておく。
    • 当事者なのか、第三者なのか。第三者なら、どういう見解の元で記事を作成しているのか。
    • 視点の偏りが生じる可能性を読み手が認識できるように。書き手の立ち位置がわからないと読み手が混乱する。
    • まあ、逆に言えば、視点の偏りを隠して都合の良い広報をしたい人はその辺りを隠すってことですよね。
  • 概略を記載する。
    • いつ起こった、何についての話なのか。記事を掲載する目的は。
    • 記事を読むのは事情を知っている人ばかりではない。全くの部外者が初めて読んでも事情がおおまかに把握できること。
  • 作成、更新のタイミング
    • いつ作成した記事か。既に解決した話なのか、現在も進行中で、随時更新される予定なのか。

本文

  • 登場人物紹介。
    • はじめましての人にとっては全員知らない人なので、何に所属する何をしてる人なのかざっくりと。
    • プライベートを晒せという意味ではなく、記事を書こうとする話の中でどういう役割なのかを書いておく。
  • 話題が複数になる場合は、章立てにするなどの工夫を。
  • 形式選択
    • 時系列に並べるか、時系列にこだわらず要点を列挙するか。
    • 文章で記載するか、箇条書きにするか。
  • できればソースも記載(これは末尾にまとめて書いてもいいかも)
  • 回りくどい表現は避ける。難しすぎる言葉や漢字は使わない。
    • 文学的な素養は必要ないです。むしろ邪魔。
  • 個人的な感情の描写は抑える。
    • まずは何があったかを説明するのが先。どう思ったかについて書きたいなら後でまとめて書こう。
  • 全体を通して、この話に関係ない余計なことは書かなくていい。書きたければ後でまとめて書くとか、注釈に入れるとか、とにかく本文中からは排除する。

末尾

書く場合は、記事が長くなることを避けるために別のページに回しても良いと思う。

  • 書き手の私見、感想を入れるならまとめて。本文にだらだらと書かない。
  • 余裕があれば更新履歴をつける。