文章への指摘を上手に受け止めて活かす方法 / How to improve your writing by listening to suggestions

うんうん唸りながらやっと書き上げたドキュメントや技術ブログ、そこへ飛んでくる容赦のないレビューコメント。湧き上がる「指摘してもらってありがたいな」という気持ちと、「いやいやこう書いた意図があるんだからこのまま直したくない」という気持ち…みなさんは自分が書き上げた文章への指摘を、上手に受け止められていますか？文章への指摘を上手に受け止めて活かす方法を、テクニカルライターが教えます。

■発表者
堀越 良子 / @mochikoAsTech / LINE株式会社 テクニカルライター。元インフラエンジニア。ねこが好き。

■ この資料は以下イベントで発表した内容です
https://line.connpass.com/event/218416/

■ 動画
※ 準備中

Transcript

1. LINE Technical Writing Meetup vol. 6 ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 How to improve your writing by listening to suggestions LINE Corporation Developer Content Team Yoshiko Horikoshi 12nd August 2021 19:00-21:00
2. 1: ⽂章への指摘を 上⼿に受け⽌めて活かす⽅法 2: どうしても読んでほしい⼈に 必ず読ませるための⽂書構造 3: Questions and Answers 12nd August 2021 19:00-21:00 LINE Technical Writing Meetup vol. 6
3. ⾃⼰紹介
4. はじめまして 「ほりこし」です
5. LINE Corporation Developer Content Team
6. 2020年1⽉から LINEでテクニカルライター
7. Yoshiko Horikoshi @mochikoAsTech プログラマ（3年） 広報（4年） インフラエンジニア（7年） 2020年1⽉からLINEでテクニカルライター
8. 「テクニカルライターってなに︖」 と思ったらLINE TWM Vol. 1をどうぞ https://www.youtube.com/watch?v=nmFVXJGiCxM&t=2815s
9. 今⽇話す内容
10. 突然ですが…
11. 技術に関する⽂章を 書いていますか︖
12. 仕様書や設計書や 技術ドキュメントを 仕事で書いてるよー︕ っていう⼈は挙⼿
13. 技術研修の資料や オンボーディングの資料を 書いてるよー︕ っていう⼈は挙⼿
14. ブログやQiitaやZenn 技術書や技術雑誌の記事を 書いてるよー︕ っていう⼈は挙⼿
15. 技術に関する⽂章を ⾊んな場⾯で 書いていますよね
16. 技術に関する⽂章を 書いている⼈から よく聞かれる質問
17. もっと⽂章を うまく書けるようになりたいです︕ どんなことに気をつけて書いたら ⽂章⼒が上がりますか︖
18. いっぱい読んで いっぱい書くといいよ︕
19. 少ないパーツで 「なんか作れ」って ⾔われるとしんどい
20. いいパーツが ⾃分の中にいっぱいあると 「いい⽂章」が 組み⽴てやすくなる
21. もっと⽂章を うまく書けるようになりたいです︕ どんなことに気をつけて書いたら ⽂章⼒が上がりますか︖
22. いっぱい読んで いっぱい書くといいよ︕
23. ちょっと 伸び悩む時期が やってくる
24. ⽂章への指摘を 上⼿に受け⽌めて活かす⽅法
25. ビギナーレベルから ⼀歩進んだ⼈に向けた話
26. 前より⽂章が うまく書けるようになった（かも） と思えたタイミング ＝「⽂章に対する指摘」の 受け⽌め⽅を変えたとき
27. 今⽇話すこと
28. ⽂章への指摘を 上⼿に受け⽌めて活かす⽅法
29. ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 1. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう 2. 完成度を⾼める前に⾒てもらおう 3. 階段は1段ずつしか上がれないと⼼得よ
30. ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 1. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう 2. 完成度を⾼める前に⾒てもらおう 3. 階段は1段ずつしか上がれないと⼼得よ
31. https://note.com/abfly/n/n04a315114fcd
32. 指摘してもらってありがたいな
33. こういう意図が背景にあるので ここはこのまま直したくない
34. 明らかな間違いだったら きっとすぐに直す
35. どっちでもよくない︖ 好みの問題じゃない︖ みたいな場合に 指摘された箇所を直すべきか否か 迷ったことはありませんか︖
36. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう
37. この2つに時間をかけるのをやめる ①指摘されたことを直すか直さないか迷う ②なんとか直さず済ませるために相⼿を説得する
38. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう
39. 「直したくないな」と思っていても 直すと「前よりいい⽂章」になる ことが圧倒的に多い
40. ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 1. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう 2. 完成度を⾼める前に⾒てもらおう 3. 階段は1段ずつしか上がれないと⼼得よ
41. ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 1. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう 2. 完成度を⾼める前に⾒てもらおう 3. 階段は1段ずつしか上がれないと⼼得よ
42. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう
43. 完成してから指摘を受けると 「迷わず即直す」が つらくて重い作業になるので 完成度が低いうちに さっさと⾒てもらおう
44. 書き始めてすぐなら ⽅向修正の労⼒は少ない でもかなり書いてから ⽅向修正しようとすると しんどいから 「迷わず即直す」ができない
45. まだ完成度が低いので ⼈には⾒せられない
46. 完成度を⾼める前に ⾒てもらおう
47. ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 1. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう 2. 完成度を⾼める前に⾒てもらおう 3. 階段は1段ずつしか上がれないと⼼得よ
48. ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 1. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう 2. 完成度を⾼める前に⾒てもらおう 3. 階段は1段ずつしか上がれないと⼼得よ
49. ⾔われてみればほんとそうですね︕ なんでこんな分かりにくい 書き⽅しちゃったんだろう… おっしゃるとおり︕直した⽅が絶対いいです。 直します。すみません︕
50. 完成度60%の 分かりにくい⽂章を書いてしまった… 恥ずかしい…︕
51. 階段は1段ずつしか上がれない
52. 完璧でなくても 下書きレベルでも そこに「⽂章」があれば それを元に議論ができて もっといい⽂章にしていける
53. 1階から6階まで⽂章を書く 指摘された箇所を直すことで 完成度が6階から8階になる
54. 初⼿で10階に⾏ける⼈はいない 上がっていく速度が速い⼈と 遅い⼈という違いはあれど 階段は1階から2階 2階から3階にしか上がれない
55. 「階段は1段ずつしか上がれない」 が分かっていれば 6階から8階に上がるための 指摘を受けたときに 必要以上に恥じ⼊らず 素直に受け⽌められる
56. ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 1. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう 2. 完成度を⾼める前に⾒てもらおう 3. 階段は1段ずつしか上がれないと⼼得よ
57. ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 1. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう 2. 完成度を⾼める前に⾒てもらおう 3. 階段は1段ずつしか上がれないと⼼得よ
58. ⽂章の改善点を上⼿に指摘する⽅法 1. 指摘の重要度合いを添えて指摘しよう 2. 具体的にどう直すべきかを 分かりやすく伝えよう
59. ⽂章の改善点を上⼿に指摘する⽅法 1. 指摘の重要度合いを添えて指摘しよう 2. 具体的にどう直すべきかを 分かりやすく伝えよう
60. MUST FIX︓ 仕様や名称の誤りなど、絶対に直してもらわないといけないもの Nice-to-have︓ 絶対ではないけれど、できれば直した⽅がいいもの Nitpicking︓ 直さなくても構わないが気になったもの
61. ⾃分が「指摘を受ける側」のとき︓ 指摘されたことを直すか直さないか 迷うのはやめて即直す
62. どれだけ直しても もう指摘するところが1つも⾒つからない 「完璧で完全無⽋な⽂章」 というものが存在しないのも事実
63. 指摘する→直す→指摘する→直す… のループがいつまでも終わらず いつまでも世に出せない
64. ⾃分が「指摘をする側」のとき︓ MUST FIX以外の指摘を 取り込むか否かは 相⼿の判断を信じて委ねる
65. ⽂章の改善点を上⼿に指摘する⽅法 1. 指摘の重要度合いを添えて指摘しよう 2. 具体的にどう直すべきかを 分かりやすく伝えよう
66. 「具体的にどう直すべきか」が読み取れない指摘の例︓ • 仕様理解が⾜りていないようです • ここ、もうちょっと分かりやすくなりませんか︖ • ◦◦の説明に怪しいところがあります • この説明だと誤解させるので直してほしいです
67. ⽂章を書いた⼈と 改善点を指摘した⼈の 共通の⽬的は 10階（完成度100%）に 早く辿り着きたい のはず
68. 具体的な修正提案をしてあげよう
69. https://docs.github.com/ja/github/collaborating-with-pull-requests/review ing-changes-in-pull-requests/commenting-on-a-pull-request 変更をPull Request上で 提案できるSuggestion機能
70. MUST FIX︓ 仕様や名称の誤りなど、絶対に直してもらわないといけないもの Nice-to-have︓ 絶対ではないけれど、できれば直した⽅がいいもの Nitpicking︓ 直さなくても構わないが気になったもの
71. ⽂章の改善点を上⼿に指摘する⽅法 1. 指摘の重要度合いを添えて指摘しよう 2. 具体的にどう直すべきかを 分かりやすく伝えよう
72. まとめ
73. ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 1. 指摘されたことを直すか直さないか 迷うのはやめて即直してみよう 2. 完成度を⾼める前に⾒てもらおう 3. 階段は1段ずつしか上がれないと⼼得よ
74. ⽂章の改善点を上⼿に指摘する⽅法 1. 指摘の重要度合いを添えて指摘しよう 2. 具体的にどう直すべきかを 分かりやすく伝えよう
75. 1: ⽂章への指摘を 上⼿に受け⽌めて活かす⽅法 2: どうしても読んでほしい⼈に 必ず読ませるための⽂書構造 3: Questions and Answers 12nd August 2021 19:00-21:00 LINE Technical Writing Meetup vol. 6
76. https://linecorp.com/ja/career/position/806
77. 1: ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 2: どうしても読んでほしい⼈に 必ず読ませるための⽂書構造 3: Questions and Answers 12nd August 2021 19:00-21:00 LINE Technical Writing Meetup vol. 6
78. このイベントのアーカイブ動画は YouTubeでご覧いただけます https://youtube.com/playlist? list=PL80ip6bOwQsIfO757li02S42XDdWdnmED
79. 次回のLINE Technical Writing Meetupは 9⽉9⽇(⽊) 19:00に開催決定 https://line.connpass.com/event/221790/