はじめに
merpay Tech Talkの「伝わる技術文書の書き方」をオンラインで視聴した際のメモです。
自分で見直す用です。
メモ
注意点
-
言葉の揺れ
-
「あらたに」と「新たに」が混在
-
-
用語辞典で「新たに」なので「新たに」に統一する
-
「サーバー」と「サーバ」が混在
-
-
漢字とひらがなの混在
-
簡潔な表現
-
「できるのであれば」vs「できれば」、「することなく」vs「せずに」
-
-
その他
-
半角の丸括弧()ではなく全角の丸括弧（）の方がベースラインが揃う
-
「はじめに」の重要性
-
記事を読んで何がわかるのか
-
これから書くことを整理する意味でも大事
文章のフレームワーク
-
フレームワークを導入する
-
このブログもテンプレートがあるけど、人のフレームワークを参考にするのもいい
-
対象読者と期待値のコントロール
-
読者は筆者が思った通りには行動しない
-
（例）社内報をもらっても読み飛ばしてしまう
-
文章を読むのは集中した後の行動なので、テーマを面白いとおもってもらえるか
-
対象読者を指定することで関心を引く
-
-
正確性とわかりやすさの関係
-
必要なタイミングで必要な情報を渡す
-
最初に全てをだすのはわかりにくい
-
結論から述べる簡潔な文章構造
-
主語を省かない
-
読者は読みやすいところから読み始めるので主語を省かない
-
-
受動態を避ける
-
受け身は主体を捉えにくいため、曖昧になることが多い
-
「される」が出てきたら注意
-
-
事実と意見
-
「便利」「簡単」などは事実ではなく意見なので「筆者は便利だと考える」と書く
トレーニングできること
-
主語と述語が対応しているか
-
主語と述語だけで文章が成り立つか
-
-
参考文献はアクセス日も合わせて記述する
-
固有名詞は正式名称を用いる、サービス名とか
セルフレビューのテクニック
-
自動化ツールを使う
-
textlint, RedPen, prhなどを使う
-
-
耳で聞く
-
OSの読み上げ機能など、耳で聞いて入ってこない文章は修正の余地あり
-
話しにくい文章もしかり
-