本記事は2021年6月17日に行われたLINE Technical Writing Meetup vol. 4のまとめになります。
https://line.connpass.com/event/213308/
公式ではなく、あくまで自分用のメモですので、詳しい内容については後日アップロードされるアーカイブを参照ください。
区別できるタイトルをつける
発表者：矢崎 誠/ LINE株式会社 テクニカルライター
前回、前々回の振り返り
- 名前を大事にする話 : 文章を見直すときのヒントになる
- 読者との距離を近づける話 : タイトルと概要に時間をかける
- 本文の並べ方 : 時系列、粒度、重要度
- 情報を整理するコツ : 誰が読むのか、いつ読むのか
良いタイトルの必要性
多くの情報を一覧で表示しても、どこに何が書いているかわからなくなる
01 3 2020更新内容
出張・旅行について
社内における各対応
イベントの対応について
感染予防について
全社方針
Q&A
多くの情報から必要な内容だけを探すのはとても難しい。
→項目ごとの違いがわかるように区別できるタイトルをつける必要がある
改善例）適切なグループ分け
- 新型肺炎コロナウイルスについて
- 新しい勤務体系（トライアル）について
- 業務などにおける感染予防
改善例）グループ内での項目の分類
×全社方針 //何でも書いてありそうで、逆に分かりづらい
◯在宅勤務、フレックス勤務 //適切なサイズに区切る
各項目がMECEになっているかどうかが重要！
どのように良いタイトルをつけるか
以下のチェックポイントで考える
- 前後の項目と正しく区別できるかどうか
- タイトルと内容が大きく離れていないか
- １つ上の階層を正しく理解していることが前提になっていないか
具体例
- Flex Message
- Flex Messageを送信する
- Flex Messageの要素
- Flex Messageのレイアウト
テクニカルライティングに学ぶ モノや概念をわかりやすく伝えるテクニック
発表者：仲田 尚央 / サイボウズ株式会社 テクニカルライター
テクニカルライティング ＝ モノやコト（概念）を伝えるための説明技術
説明の鉄則
概要から具体へ また 全体から部分へ を絶対に守る。
説明の具体的なポイント
- 最初に概要/全体を端的に言う
- 相手に合わせて説明の粒度を変える（相手にとって難しい用語には説明を加える）
- モノや概念を分解する２つの方法
- 具体例で分解する
- 構成要素で分解する
- 要素同士の関係を説明する
- 配分に注意して、テーマからずらさないようにする
その他
Q＆Aで紹介されていた本