1. yykamei's Podcast
  2. #26 読み手ファーストな文書
2024-05-04 09:30

#26 読み手ファーストな文書

読み手ファーストな文書って大事ですよね、という話をしました。特に、概要というセクションがあるのに「概要」になっていない文書とか、テンプレートに沿った文書で説得力がない文書について言及しました。いずれにしろ、読み手が誰なのか?そしてその読み手に刺さるような文書というのを心がけたいですね、という話をしています。

00:01
はい、kameiです。 yykamei's Podcastやってきます。
今回のトピックは、読み手ファーストな文書、です。
私の所属組織の文書、コンフルエンスで書かれているんですけど、
それをたくさん最近読むことが多くてですね、
読んでいると、なかなか言ってしまえば読みづらい文書が多いなと感じるところで、
今回そんな話をしてみたいと思います。
なんで読みづらいのかっていろいろ考えてみたんですけど、
まず、私が読んでいる文章が私向けに書かれていないっていうのもあるかもしれないんですけど、
それにしても読みづらいなって思うことが多いと。
どこで読みづらさを覚えたのかというと、
例えば、企画書っていうのが最近ありまして、
企画書を使って捨て込みですね、ステアリング込みっていっているので議論されて、
それが次にどんなプロジェクトをやるべきかみたいなところで話されるための
結構重要な文書だったりするんですけど、
その企画書の内容を読んでもよくわからないんですよね。
企画書ってコンテキストがあるから、企画書だなっていうのはわかるんですけど、
その企画の内容があまりよくわかんない。
よくわかんない理由をいくつか挙げてみると、
まずその企画書にはテンプレートがあって、
テンプレートに沿って書かれているのはいいんですけど、
テンプレートに概要とかそういうのがないので、
何のための文書なのかっていうのはよくわかんないんですよね。
全部読み込んで、詳細まで読み込んで初めてわかるみたいな文書になっているので、
あんまりちょっと読み手ファーストな文書ではないなっていうのを感じるところでございます。
で、概要がないだけではなくて、
その個々のセクション、項目についても、
まといない内容が書かれているんですよね。
例えばこれによってどんな効果があるかみたいなところに、
効果を書いて欲しかったり、
どんな数字が書いているのかっていうのを書いてはいるんですけど、
なぜみたいなところとかも書いてあったりして、
そのセクション名と内容が微妙に一致しなかったりすることが多いんですよね。
本当にこの企画書、
企画書テンプレートが悪いのかわかんないんですけど、
ちょっと読みづらいなって思うことが多いです。
先ほど言ったその概要の話なんですけど、
これは企画書に限ったことではなくて、
結構、概要っていうセクションがあるのに、
概要が何言ってるかわかんないというか、
そもそも概要が概要になってなくて、
わっと、その文章の内容が列挙されている。
文章の内容が列挙されているはいいんですけど、
単に箇条書きで書いたって、
03:01
ん?っていうようなことが多いんですよね。
文章、本当にそうなんですよ。
概要が概要になってないっていうのは結構よく見るなっていう感じがします。
あと、そもそもその文章が何のための文章で、
何を目的としたい文章なのかが書かれていないことも結構多いなと思います。
これも概要に書くのか、
あるいはそもそもこの文章とはね、みたいなのが
もっと最初の方にあってもいいんじゃないかなっていう気はするんですよね。
例えば、私の組織がConfluenceを使ってるって言ったんですけど、
Confluenceで検索をして、
たまたま何かのキーワードでヒットした文章がそれで、
その文章を見て、なんかいろいろ書いてあるんですけど、
検索してヒットした文章、
それが自分の目的とした文章なのかどうかすらわからないんですよね。
検索してヒットしたバターンって。
そうした時に、この文章は何ですっていうのが書いてあると、
非常に役に立つんですよね。
昨今の文章管理システムは、
だいたい検索機能を備えているわけですし、
情報を取得しようとする時って、
だいたい検索するんじゃないかなって思うんですよね。
もちろんフォルダ分けされていて、
きれいにフォルダ分けされているので、
フォルダのツリーをどんどん掘っていけば、
この文章にたどり着く。
そういう人にとっては、
その文章はそのフォルダ内にあるから、
もうわかるでしょって感じなのかもしれないんですけど、
検索って使わないんですかね。
もちろんフォルダ分けが大事なのはわかるんですけど、
検索使うと思うんですよね。
検索でたどり着いた時に、
文章の内容がわかんないと、
結構苦労するなと。
それこそ、認知負荷ですよ。
あと、また話を戻るんですけど、
企画書のところで言ったテンプレートですね。
テンプレートの構材ってあるんじゃないかなって思ってまして、
テンプレート埋めればいいって言って、
埋まっているだけみたいな文章って結構あるんですよね。
私からすればあるんですよね。
とりあえず内容は埋まっている。
内容は埋まっているんだけど、
何言いたいのかよくわかんないって感じることが多いです。
このテンプレートに関しては特に、
デベロッパーはよくそういう傾向にありがちだなと思います。
というのも、
例えばGitHubではプルリクエストのテンプレートとか
一瞬のテンプレートを用意することができるんですけど、
プルリクエストをオープンした段階で、
そのテンプレートが表示されて、
だいたいそのテンプレート通りに埋めていくわけですよね。
そのテンプレート埋まっているんですけど、
06:00
なんかよくわかんないんですよね。
そもそも概要という欄があるのに、
やっぱり概要じゃなくて、
そのプルリクエストのWHAT、
どんな変更というのが書いてあったりして、
プルリクエストの場合は、
そもそもファイルズチェンジ等で変更内容を見るんだから、
WHATは役に立つことはあるんだけど、
そこまで重要じゃないよねと。
そういうのを書いて欲しいんですよねという気はします。
そういう背景があるから、
こういう変更をするに至ったみたいなものが書いてあって、
初めてファイルズチェンジで読んで、
なるほどねという風になるんじゃないかなと思うんです。
いずれにしろそのテンプレートというのは、
本当に埋まっているだけという状態の文章は、
読みづらいなって思うことがあります。
そういったものをどういう文章を作ればいいのというのは、
つまり、読み手のことを考えるということが、
文章を書く上で重要なんじゃないかなという気がします。
重要というのはつまり、
読み手のことを考えた文章を書けば、
読み手、読む人にとって分かりやすくなるよねと。
この読み手というのがまず重要で、
そもそも読み手は誰ですかと、
誰のための文章なんでしょうかと。
そういうのが重要ですよね。
先ほどの企画書というのも、
読み手って、
私の組織で言えば捨て込みのメンバー、
そして多分もうちょっと上のレイヤーというか、
トップ層ですよね、
シニアステークホルダーですか、
が読むはずなんですけど、
シニアステークホルダーってそれこそめちゃくちゃ忙しい人たちなはずで、
その人たちがサクッと概要をつかんで、
それでいて、ある程度こっしをつかむことができる必要があるんじゃないかなと、
思うんですよね。
いずれにしろその読み手って誰なのっていうのは非常に重要かなと。
時間がない人向けにやるんだったら絶対概要って必要なはずなんですよね。
とにかく読み手は誰っていうのを考えようと。
その誰っていう人に刺さるような文章っていうのが大事ですよね。
これに関しては訓練しかできないので、
読み手は誰かというのを考えようと。
その誰っていう人に刺さるような文章っていうのが大事ですよね。
これに関しては訓練しかないというか、
どういう風な文章だったらその人に響くのか。
もちろん分かりやすさっていうのは非常に重要で、
その上で説得力がある文章っていうのは大事ですよね。
というかコミュニケーションの手段っていろいろあるんですけど、
そのうちの一つの文章っていうのを選んでいるのであれば、
文章で人を納得させる必要があると。
であればその読み手に刺さるような文章っていうのがやっぱり求められる。
であればその読み手に刺さるような文章っていうのがやっぱり求められる。
であればその読み手に刺さるような文章っていうのがやっぱり求められる。
それは常々心がけたいなという気はします。
それは常々心がけたいなという気はします。
あと最後にもう一回同じことを言うんですけど、
概要ってセクション設けるのはちゃんと概要になるようにしたいですよね。
概要ってそもそもサマリーですよ。
09:01
サマライズするっていうことは本体があるわけで、
なんなら本体から書いてもいいと思うんですよね。
で最後に概要を書くみたいな。
書き手も概要から書きがちなんですけど、
実は概要って全体のサマリーなはずなので、
概要を後に書くっていうのは割といいんじゃないかなと個人的には思うところであります。
概要を後に書くっていうのは割といいんじゃないかなと個人的には思うところであります。
はい、そんな感じで今回は
読み手ファーストな文章というタイトルでお送りしました。
それではまた。
09:30

コメント

スクロール