見出し画像

[技術ライティング講座]講座の振り返り#4

ホッタです。

2024年1月から、ノンプロ研で技術ライティング講座を受講しています。2月9日(金)に第4回目の講義がありました。その内容について印象に残ったことや学びになったことを書いていきます。

今回のテーマは「文章を書く技術1」です。いよいよ書くことについて学んでいきます~

講座第4回のTogetterまとめはこちら↓↓↓


ラクに書くための技術

前回から引き続き、ラクに書くための技術を学んでいきます。ラクに書くためには選択肢を減らすのが有効です。前回は「素材を集める」について学びましたが、今回は「ターゲットを決める」と「構造を考える」について学んでいきます。

今回のテーマ

ターゲットを決める

文章を書くということは、それを読む人がいます。ターゲットとは文章の想定読者のことです。
一般的な読者ターゲットというと、年齢・性別・職業・学歴・趣味などが想定されますが、ターゲットはシンプルに「自分が読みたかった文章を書く」だけでとりあえずOKということです。他人ではなく、過去の自分をターゲットとして書くということです。

過去の自分をターゲットとする理由は、以下のスライドの通りです。自分のことは自分が一番良く知っていますので、ラクに書けるということです。

過去の自分をターゲットにするのがオススメ

ただし、自分のことであってもターゲットは整理して明文化しておく必要はあります。そうしないと、いざ書くときに内容がブレてしまいます。
ターゲットは以下の観点で整理します。

  • 環境や背景

  • 課題と目的

  • 知識

環境や背景

環境や背景は、例えば以下のような感じです。

環境や背景

自分の環境や背景をベースに書くのがオススメです。その理由は、選択肢を減らせるのと、自分の経験に基づくので説得力があるからです。
もし、自分の体験していないことを書くためには「取材」が必要になるので、難易度が上がります。

課題と目的

次は課題と目的です。私達が何かを学ぶときは、課題を解決する方法を学ぶというのが基本です。文章を読むことで目的を達成する=課題を解決するコストを下げることができれば、それが文章の価値になるのです。図にするとこんな感じです。

文章の価値

私がこれから書こうとする文章は、新発見の技術でない限り、過去に同じ技術について書かれている書籍や記事があるはずです。
しかし、想定するターゲットが私の文章を読んだときに、それら書籍や記事よりも低コストでその技術を習得することができたら、それが文章の価値になります。

知識

次に、ターゲットの知識です。これは読者が文章を読んで理解するのに必要な前提知識のことです。たとえば、プログラミングに関する文章であれば、そのプログラミング言語についてどれくらいの前提知識が必要かを想定しておきます。

もしPythonで何かのライブラリについての技術文書を書くとき、全くの初心者をターゲットにするのであれば、Pythonの基本文法から説明する必要があります。本屋でよく見るようなPython関連の書籍は、最初にPython基本文法をひととおり説明しているものや、巻末に付録として基本文法の説明が載っているものが多いです。

私達が書く文章は必ずしも初心者を対象にする必要はないのですが、読者にどの程度の知識があるかを想定し、必要に応じて言葉の説明をする必要があります。

前提知識を考える

文章の構造を考える

次に必要なのは、文章の構成です。構成要素と、構成要素間の関係を整理することを、構造化といいます。
構造化の手順は以下の3つです。

  1. グルーピングする

  2. 名前をつける

  3. 順番を決める

技術に関する文章は、構造化によって読みやすくする必要があります。もし技術書が物語のように章立てもなく書かれていたら。きっと読む気もしないでしょう。

まずはグルーピングです。
なぜグルーピングするか。それは人が同時に処理できる情報は5個程度なので、たくさんの情報をグループにまとめることで可視範囲の情報を減らすためです。
書く素材がたくさんある場合は、4~5個のグループにまとめます。さらにそのグループ内の要素も常に5個以内になるようにまとめていくと良いそうです。

グルーピング

次にそのグループに名前をつけます。文章であれば、その構成要素の見出しです。名前は長すぎず、わかりやすく意味があるものにします。
プログラミングで変数や関数に名前をつけるのと同じですね。

最後に順番です。グループ化して名前をつけたら順番を決めます。文章は連続したつながりで書きます。2つの要素を並列で書くことはできません。仮に左右並べて書いたとしても、同時に読むことはできません。
よって、書くためには必ず順番を決める必要があります。

順番の決め方は、自然かつ理解のしやすい順序にします。
基本的には、以下のようなことを考えながら順番を決めていきます。

  • 前提となる事項を先に

  • 簡単→難しい

  • 定義→使用

文章を書き始める前に文章の構造(=目次)を決めてから書き始めます。技術同人誌を書く場合、文章の構造を決めて企画書に書くことから始まりますが、書きながら構成を見直すことはよくあるそうです。とは言え最初に決めておくことで書くのがラクになるのは間違いないとのことです。

まとめ

今回のまとめです。

  • 技術文書の読者ターゲットは、過去の自分にするのがオススメ

  • 課題を解決するコストを下げることが文章の価値になる

  • 読者の前提知識を想定して書く

  • グループ化し、名前をつけて順番を決めることで文章の構造化を行う

だいぶ書く技術が具体的になってきました。講義の最後には過去の技術同人誌の企画書を少し見せてもらったりして、書くことの実感が少しずつ湧いてきました。まだ前回学んだネタ集めと平行してネタを文章に書く時のターゲットや構造化についても意識していきたいと思います。

今回は以上です。最後まで読んでいただき、ありがとうございました。

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