趣味の開発ノート

ITの学習やプログラミング・ノーコードアプリ開発のことなど。

【ノンプロ研】技術ライティング講座 第5回「文章を書く技術2」まとめと演習

ノンプロ研で開催されている「技術ライティング講座 第5期」にホストとして参戦中。

tonari-it.com

この講座では「技術に関する文章を書くための知識とスキルを身につける」をゴールに、全9回+卒業LTという日程で学んでいます。

6/8(水)、5回目の講座が開催されました。 今回もまとめと演習に取り組んでいきます。

講座内容まとめ

5回目のテーマは「文章を書く技術2」です。
ここ複数回にわたって、「文章をラクに書く」ために「素材を集める」「ターゲットを決める」「構造を考える」というテクニックを学んできました。今回は「作法を知る」ということで、文章をリーダブルに書くための7つの作法について、学びました。

togetter

当日の受講生の皆さんのツイートまとめです。
このようにノンプロ研では受講中Twitterでのアウトプットを推奨しており、毎回講師の方がまとめを作ってくれています。

togetter.com

講座のアジェンダ

  1. 良い文章とは
  2. リーダブルに書く技術

内容

ひとつめの【良い文章とは】では、良い文章の定義について確認しました。

ズバリ良い文章とは、読者がより少ない時間で課題の解決ができる文章です。

読者に時間というコストをかけさせずに、目標を達成してもらうことが伝える価値となります。例えば初心者向けにキーワードを整理したり複数の記事をまとめたりすることで、価値を提供することができます。

ここで気をつけるべきは、コストを下げるために目標を下げないことです。難しい概念の説明を省いたり、暗記やコピペを推奨するのではなく、達成する目標はそのままに理解してもらえるような書く必要があります。

ふたつめの【リーダブルに書く技術】では、具体的に良い文章を書くための7つの作法を学びました。

  1. 一度に一つのことを
  2. 明確にする
  3. ガイドする
  4. 見た目をやさしく
  5. 一貫性を持たせる
  6. 適切な密度で
  7. 自然な構造にする

講師おすすめのやり方は、自身の書いた文章を見直す際に「それぞれの視点で7回読み直す」ということ。なかなかハードですが、漠然と読み直すのではなく客観的に見る訓練にもなるのかなと思います。

またこれらの作法はプログラミングの作法がまとまった書籍「リーダブルコード」にならっています。コードを書くときも文章を書くときも、とにかく読み安く!することが大切です。

演習

今回は、全ての演習ではなく一部に絞ってアウトプットすることにしました。
その代わりに自主課題として「7つの作法について自身の活用しやすい形にまとめる」というのをやりました。

◯ -> 質問(講座中にチャットで回答)
★ -> 宿題

◯演習5-1:「良くない文章」とは

良くない文章」とはどんな文章でしょう?

👉
文章が長く、何が言いたいのかわからないような文章かな、と思います。

自分もブログを書くときや人前で話すときに、主張がはっきりしない長い文章を書いて(話して)しまいがちです。
逆説的に「良くない文章」を意識しておくのは大事だなと思いました。

★演習5-6:意識したい作法トップ3

7つの作法のうち、もっとも気をつけたいものを、ランキング形式で3位まで選んでください。
また、選出した理由も教えてください。

👉

  • 第1位:5. 一貫性をもたせる
  • 第2位:1. 一度に一つのことを
  • 第3位:2. 明確にする

それぞれ、以下の理由です。

第1位:5. 一貫性をもたせる

「パターンを用いる」という手法を意識して使いたいなと思いました。
例えば箇条書きにしたり、似たような項目は対比的に書くことで、読者はパターンに慣れて読みやすくなる、とのこと。使えるようになるまで意識してマスターしたいテクニックです。

第2位:1. 一度に一つのことを

文章の構造に関わるすごく基本的な作法だと思いました。
一文を短く分割する。一つの段落には一つの主張を。またブログ記事などのまとまった文章では、節(章)が変わる前にまとめの一文を入れて回収する、というのも意識したいです。

第3位:2. 明確にする

細かいポイントですが「主語と術後を確実に関係させる」「指示語を使いすぎない」というのは意識しないと忘れてしまいがちだな、と思いました。

★演習5-7:リーダブルな文章への書き換え

演習4-8の文章について、よりリーダブルな文章となるように書き換えてみましょう。
前回のページは上書きせずに、新たなページを作成して比較できるようにしてください。

👉
さて、一連の課題が溜まってきました…。
課題が少ないこのタイミングで、取り組んで別記事にてみようと思います。

★自主課題:7つの作法まとめ

7つの作法について、自身の活用しやすい形にまとめてみましょう。

👉
(1)togetterまとめ

講座中のツイートを自分で活用しやすい形にまとめました。
今回の「7つの作法」に加えて、前回の「文章の構造化」についても見返したかったので一緒に入れてみました。

togetter.com

(2)リーダブル作法カード

過去に7つの作法カードをL版用紙に印刷して活用しています。その内容を見直しました。

docs.google.com

おわりに

これまで3回にわたって、文章をラクに書くための技術について学んできました。技術ライティングの真髄がギュッと詰まった回だったなと思います。
いきなり文章を書こうとせず、事前にしっかり準備しておくことが大切なのでした。まずは「素材集め」をしたのちに「ターゲット決め」「文章の構造化」をする。その後「良い文章の作法」を意識して文章を書き、何度も見返すこと。

こうやってみると、文章をラクに書くためにすることは全然ラクじゃないですね…w
ともあれ、この習慣を徹底したいと思います!