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

Slide 1

Slide 1 text

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

Slide 2

Slide 2 text

1: ⽂章への指摘を上⼿に受け⽌めて活かす⽅法 2: どうしても読んでほしい⼈に必ず読ませるための⽂書構造 3: Questions and Answers 12nd August 2021 19:00-21:00 LINE Technical Writing Meetup vol. 6

Slide 3

Slide 3 text

⾃⼰紹介

Slide 4

Slide 4 text

はじめまして「ほりこし」です

Slide 5

Slide 5 text

LINE Corporation Developer Content Team

Slide 6

Slide 6 text

2020年1⽉から LINEでテクニカルライター

Slide 7

Slide 7 text

Yoshiko Horikoshi @mochikoAsTech プログラマ（3年）広報（4年）インフラエンジニア（7年） 2020年1⽉からLINEでテクニカルライター

Slide 8

Slide 8 text

「テクニカルライターってなに︖」と思ったらLINE TWM Vol. 1をどうぞ https://www.youtube.com/watch?v=nmFVXJGiCxM&t=2815s

Slide 9

Slide 9 text

今⽇話す内容

Slide 10

Slide 10 text

突然ですが…

Slide 11

Slide 11 text

技術に関する⽂章を書いていますか︖

Slide 12

Slide 12 text

仕様書や設計書や技術ドキュメントを仕事で書いてるよー︕ っていう⼈は挙⼿

Slide 13

Slide 13 text

技術研修の資料やオンボーディングの資料を書いてるよー︕ っていう⼈は挙⼿

Slide 14

Slide 14 text

ブログやQiitaやZenn 技術書や技術雑誌の記事を書いてるよー︕ っていう⼈は挙⼿

Slide 15

Slide 15 text

技術に関する⽂章を⾊んな場⾯で書いていますよね

Slide 16

Slide 16 text

技術に関する⽂章を書いている⼈からよく聞かれる質問

Slide 17

Slide 17 text

もっと⽂章をうまく書けるようになりたいです︕ どんなことに気をつけて書いたら⽂章⼒が上がりますか︖

Slide 18

Slide 18 text

いっぱい読んでいっぱい書くといいよ︕

Slide 19

Slide 19 text

少ないパーツで「なんか作れ」って⾔われるとしんどい

Slide 20

Slide 20 text

いいパーツが⾃分の中にいっぱいあると「いい⽂章」が組み⽴てやすくなる

Slide 21

Slide 21 text

もっと⽂章をうまく書けるようになりたいです︕ どんなことに気をつけて書いたら⽂章⼒が上がりますか︖

Slide 22

Slide 22 text

いっぱい読んでいっぱい書くといいよ︕

Slide 23

Slide 23 text

ちょっと伸び悩む時期がやってくる

Slide 24

Slide 24 text

⽂章への指摘を上⼿に受け⽌めて活かす⽅法

Slide 25

Slide 25 text

ビギナーレベルから⼀歩進んだ⼈に向けた話

Slide 26

Slide 26 text

前より⽂章がうまく書けるようになった（かも）と思えたタイミング＝「⽂章に対する指摘」の受け⽌め⽅を変えたとき

Slide 27

Slide 27 text

今⽇話すこと

Slide 28

Slide 28 text

⽂章への指摘を上⼿に受け⽌めて活かす⽅法

Slide 29

Slide 29 text

⽂章への指摘を上⼿に受け⽌めて活かす⽅法 1. 指摘されたことを直すか直さないか迷うのはやめて即直してみよう 2. 完成度を⾼める前に⾒てもらおう 3. 階段は1段ずつしか上がれないと⼼得よ

Slide 30

Slide 30 text

Slide 31

Slide 31 text

https://note.com/abfly/n/n04a315114fcd

Slide 32

Slide 32 text

指摘してもらってありがたいな

Slide 33

Slide 33 text

こういう意図が背景にあるのでここはこのまま直したくない

Slide 34

Slide 34 text

明らかな間違いだったらきっとすぐに直す

Slide 35

Slide 35 text

どっちでもよくない︖ 好みの問題じゃない︖ みたいな場合に指摘された箇所を直すべきか否か迷ったことはありませんか︖

Slide 36

Slide 36 text

指摘されたことを直すか直さないか迷うのはやめて即直してみよう

Slide 37

Slide 37 text

この2つに時間をかけるのをやめる ①指摘されたことを直すか直さないか迷う ②なんとか直さず済ませるために相⼿を説得する

Slide 38

Slide 38 text

指摘されたことを直すか直さないか迷うのはやめて即直してみよう

Slide 39

Slide 39 text

「直したくないな」と思っていても直すと「前よりいい⽂章」になることが圧倒的に多い

Slide 40

Slide 40 text

Slide 41

Slide 41 text

Slide 42

Slide 42 text

指摘されたことを直すか直さないか迷うのはやめて即直してみよう

Slide 43

Slide 43 text

完成してから指摘を受けると「迷わず即直す」がつらくて重い作業になるので完成度が低いうちにさっさと⾒てもらおう

Slide 44

Slide 44 text

書き始めてすぐなら⽅向修正の労⼒は少ないでもかなり書いてから⽅向修正しようとするとしんどいから「迷わず即直す」ができない

Slide 45

Slide 45 text

まだ完成度が低いので⼈には⾒せられない

Slide 46

Slide 46 text

完成度を⾼める前に⾒てもらおう

Slide 47

Slide 47 text

Slide 48

Slide 48 text

Slide 49

Slide 49 text

⾔われてみればほんとそうですね︕ なんでこんな分かりにくい書き⽅しちゃったんだろう… おっしゃるとおり︕直した⽅が絶対いいです。直します。すみません︕

Slide 50

Slide 50 text

完成度60%の分かりにくい⽂章を書いてしまった… 恥ずかしい…︕

Slide 51

Slide 51 text

階段は1段ずつしか上がれない

Slide 52

Slide 52 text

完璧でなくても下書きレベルでもそこに「⽂章」があればそれを元に議論ができてもっといい⽂章にしていける

Slide 53

Slide 53 text

1階から6階まで⽂章を書く指摘された箇所を直すことで完成度が6階から8階になる

Slide 54

Slide 54 text

初⼿で10階に⾏ける⼈はいない上がっていく速度が速い⼈と遅い⼈という違いはあれど階段は1階から2階 2階から3階にしか上がれない

Slide 55

Slide 55 text

「階段は1段ずつしか上がれない」が分かっていれば 6階から8階に上がるための指摘を受けたときに必要以上に恥じ⼊らず素直に受け⽌められる

Slide 56

Slide 56 text

Slide 57

Slide 57 text

Slide 58

Slide 58 text

⽂章の改善点を上⼿に指摘する⽅法 1. 指摘の重要度合いを添えて指摘しよう 2. 具体的にどう直すべきかを分かりやすく伝えよう

Slide 59

Slide 59 text

⽂章の改善点を上⼿に指摘する⽅法 1. 指摘の重要度合いを添えて指摘しよう 2. 具体的にどう直すべきかを分かりやすく伝えよう

Slide 60

Slide 60 text

MUST FIX︓ 仕様や名称の誤りなど、絶対に直してもらわないといけないもの Nice-to-have︓ 絶対ではないけれど、できれば直した⽅がいいもの Nitpicking︓ 直さなくても構わないが気になったもの

Slide 61

Slide 61 text

⾃分が「指摘を受ける側」のとき︓ 指摘されたことを直すか直さないか迷うのはやめて即直す

Slide 62

Slide 62 text

どれだけ直してももう指摘するところが1つも⾒つからない「完璧で完全無⽋な⽂章」というものが存在しないのも事実

Slide 63

Slide 63 text

指摘する→直す→指摘する→直す… のループがいつまでも終わらずいつまでも世に出せない

Slide 64

Slide 64 text

⾃分が「指摘をする側」のとき︓ MUST FIX以外の指摘を取り込むか否かは相⼿の判断を信じて委ねる

Slide 65

Slide 65 text

⽂章の改善点を上⼿に指摘する⽅法 1. 指摘の重要度合いを添えて指摘しよう 2. 具体的にどう直すべきかを分かりやすく伝えよう

Slide 66

Slide 66 text

「具体的にどう直すべきか」が読み取れない指摘の例︓ • 仕様理解が⾜りていないようです • ここ、もうちょっと分かりやすくなりませんか︖ • ○○の説明に怪しいところがあります • この説明だと誤解させるので直してほしいです

Slide 67

Slide 67 text

⽂章を書いた⼈と改善点を指摘した⼈の共通の⽬的は 10階（完成度100%）に早く辿り着きたいのはず

Slide 68

Slide 68 text

具体的な修正提案をしてあげよう

Slide 69

Slide 69 text

https://docs.github.com/ja/github/collaborating-with-pull-requests/review ing-changes-in-pull-requests/commenting-on-a-pull-request 変更をPull Request上で提案できるSuggestion機能

Slide 70

Slide 70 text

Slide 71

Slide 71 text

⽂章の改善点を上⼿に指摘する⽅法 1. 指摘の重要度合いを添えて指摘しよう 2. 具体的にどう直すべきかを分かりやすく伝えよう

Slide 72

Slide 72 text

まとめ

Slide 73

Slide 73 text

Slide 74

Slide 74 text

⽂章の改善点を上⼿に指摘する⽅法 1. 指摘の重要度合いを添えて指摘しよう 2. 具体的にどう直すべきかを分かりやすく伝えよう

Slide 75

Slide 75 text

Slide 76

Slide 76 text

https://linecorp.com/ja/career/position/806

Slide 77

Slide 77 text

Slide 78

Slide 78 text

このイベントのアーカイブ動画は YouTubeでご覧いただけます https://youtube.com/playlist? list=PL80ip6bOwQsIfO757li02S42XDdWdnmED

Slide 79

Slide 79 text

次回のLINE Technical Writing Meetupは 9⽉9⽇(⽊) 19:00に開催決定 https://line.connpass.com/event/221790/