「コード品質向上のテクニック」連載継続の秘訣

Technical Writing Meetup vol.41 での登壇資料です。
セッション概要: LINEヤフー Tech Blog では「コード品質向上のテクニック」という連載を、一年以上にわたってほぼ毎週公開しています。しかし、このようにアウトプットを継続するには、少なからぬ時間や根気が必要です。本セッションでは、なぜ連載を続けられているのか、その秘訣をご紹介します。

Transcript

1. ʮίʔυ඼࣭޲্ͷςΫχοΫʯ
   
   
   
   ࣥචܧଓͷൿ݃
   
   
   
   
   .VOFUPTIJ
   *TIJLBXB
2. -*/&Ϡϑʔ
   ͷιϑτ΢ΣΞΤϯδχΞ
    ৽ଔ࠾༻ɾ৽ଔڭҭͷվળ
    -*/&
   $MJFOU
   "OESPJEJ04
   ͷ։ൃ
    ଞ։ൃ෦ॺͷٕज़αϙʔτ
   ϒϩά࿈ࡌ
   ίʔυ඼࣭޲্ͷςΫχοΫ
   ॻ੶
   ಡΈ΍͍͢ίʔυͷΨΠυϥΠϯ
   ΤϯδχΞνʔϜͷੜ࢈ੑͷߴΊํ .VOFUPTIJ
   *TIJLBXB
3. -*/&Ϡϑʔ
   5FDI
   #MPH
   ্ͷ࿈ࡌهࣄ
    ίʔυ඼࣭ʹؔ͢Δ
   5JQT
    
   ೥
   
   ݄͔Β΄΅ຖि࿈ࡌ
   ݱࡏྦྷܭ
   
   ճ
   ίʔυ඼࣭޲্ͷςΫχοΫ IUUQTUFDICMPHMZDPSQDPKQKBDPEFSFWJFXTFSJFT
4. ܧଓ͢Δൿ݃͸େ͖͘
   
   ͭ
    ڞ༗ͷʮ৔ʯΛఆظతͳΠϕϯτͱͯ͠ઃ͚Δ
    ڱ͍ൣғ
   
   ؆୯ͳܗ͔ࣜΒஈ֊తʹڞ༗͢Δ ͜ͷηογϣϯΛ
   
   ߦͰ
5.  ϒϩάهࣄࣥචͷྲྀΕ
    ࣥචܧଓͷൿ݃
    Ξ΢τϓοτΛ૿΍͢ํ๏ 5PQJDT
6.  ϒϩάهࣄࣥචͷྲྀΕ
    ࣥචܧଓͷൿ݃
    Ξ΢τϓοτΛ૿΍͢ํ๏ 5PQJDT
7. -*/&
   $MJFOU
   ෦ॺ಺Ͱڞ༗͢ΔϨϙʔτ͕ىݪ
    3FWJFX
   $PNNJUUFF
   ͷ׆ಈ
   ͱͯ͠ϨϙʔτΛڞ༗
    ଞͷ։ൃ෦ॺʹ΋ϨϙʔτΛڞ༗
    ϨϙʔτΛϒϩάهࣄͱͯ͠ฤूɾެ։ ϒϩάهࣄࣥචͷྲྀΕ
8. -*/&
   $MJFOU
   ෦ॺͷίʔυ඼࣭޲্ͷऔΓ૊Έ
    .FSHF
   ࡁΈͷίʔυΛ࠶౓ϨϏϡʔ
    ӳޠͷϨϙʔτΛ෦ॺͰڞ༗
   ຖि 3FWJFX
   $PNNJUUFF
   ͷ׆ಈ Development team merge request review Codebase Review committee review feedback discussion “Twemoji” © Twitter, Inc and other contributors (Licensed under CC BY 4.0) https://twemoji.twitter.com/ report
9. -*/&
   $MJFOU
   ෦ॺͷίʔυ඼࣭޲্ͷऔΓ૊Έ
    .FSHF
   ࡁΈͷίʔυΛ࠶౓ϨϏϡʔ
    ӳޠͷϨϙʔτΛ෦ॺͰڞ༗
   ຖि
   
   ೥ޙظ͔Β໿
   
   ೥൒ܧଓ 3FWJFX
   $PNNJUUFF
   ͷ׆ಈ
10.  -*/&
    $MJFOU
    ಠࣗͷίʔυͷॻ͖ํϧʔϧ
     ϞόΠϧΫϥΠΞϯτྖҬϓϩάϥϛϯάݴޠݻ༗ͷςΫχοΫ
     ιϑτ΢ΣΞ։ൃҰൠͷϕετϓϥΫςΟε
    ଞͷ։ൃ෦ॺʹ΋ڞ༗Ͱ͖Δ
    8FC
    GSPOUFOE#BDLFOE Ϩϙʔτͷ಺༰
11. աڈͷهࣄ͔Βιϑτ΢ΣΞ։ൃҰൠͷτϐοΫΛબผ
     ӳޠ͔Β೔ຊޠʹ຋༁
     ࿩͠ʹ͔ͬͨ͘఺ޡղΛট͘఺ͳͲͷิ଍ ଞͷ։ൃ෦ॺ΁ͷڞ༗
12. ೔ຊޠԽͨ͠ϨϙʔτΛ΄΅ͦͷ··هࣄʹ
     ࿩͠ʹ͔ͬͨ͘఺ΛՃචमਖ਼
     ࣾ಺ߍਖ਼πʔϧ
    
    ੜ੒
    "*
    Ͱߍਖ਼ 5FDI
    #MPH
    هࣄ΁
13. -*/&
    $MJFOU
    ෦ॺ಺Ͱڞ༗͢ΔϨϙʔτ͕ىݪ
     3FWJFX
    $PNNJUUFF
    ͷ׆ಈ
    ͱͯ͠ϨϙʔτΛڞ༗
     ଞͷ։ൃ෦ॺʹ΋ϨϙʔτΛڞ༗
     ϨϙʔτΛϒϩάهࣄͱͯ͠ฤूɾެ։ ϒϩάهࣄࣥචͷྲྀΕ
    ࠶ܝ
14.  ϒϩάهࣄࣥචͷྲྀΕ
     ࣥචܧଓͷൿ݃
     Ξ΢τϓοτΛ૿΍͢ํ๏ 5PQJDT
15. ·ͣ͸෦ॺ಺޲͚ʹॻ͘
     ෦ॺ಺ͱ͍͏҆৺ײ
     ఆظϛʔςΟϯάͷϓϨογϟʔ
    ஈ֊తʹڞ༗ൣғΛ޿͛Δ
     ແཧͷͳ͍ࠩ෼
     ஈ֊͝ͱͷόοϑΝ ࣥචܧଓͷൿ݃
16. ·ͣ͸෦ॺ಺޲͚ʹॻ͘
     ෦ॺ಺ͱ͍͏҆৺ײ
     ఆظϛʔςΟϯάͷϓϨογϟʔ
    ஈ֊తʹڞ༗ൣғΛ޿͛Δ
     ແཧͷͳ͍ࠩ෼
     ஈ֊͝ͱͷόοϑΝ ࣥචܧଓͷൿ݃
17. ؒҧ͍ͬͯͯ΋ڐ͞ΕΔͱ͍͏৺ཧత҆શੑ
     ӳޠͷจ๏΍ޠኮͷؒҧ͍
     ίʔυͷؒҧ͍
     ओு΍ετʔϦʔͷؒҧ͍
    ਂࠁʹ೰·ͣʹॻ͖࢝ΊΒΕΔ ෦ॺ಺ͱ͍͏҆৺ײ
18. ࿩͢͜ͱʹΑΔվળ఺ͷൃݟ
     ΑΓೲಘ͠΍͍͢ετʔϦʔ
     ิ଍͢Δ΂͖આ໌ ෦ॺ಺ͱ͍͏҆৺ײ
    DPOU A ͱ B ͕୅දྫͰ͢ ͋ͱ C ΋ॏཁͳྫͰ͢Ͷ ͋ͱͰ C Λิ଍͓ͯ͜͠͏ 
 Report Foo
 
 ୅දྫ
 A: ...
 B: ... “Twemoji” © Twitter, Inc and other contributors (Licensed under CC BY 4.0) https://twemoji.twitter.com/
19. ʮΞώϧͪΌΜʯʹ࿩ͯ͠໰୊Λ੔ཧ͢Δख๏
     ݩདྷ͸σόοάͷख๏
     5IF
    1SBHNBUJD
    1SPHSBNNFS
    Ͱ঺հ
    ࿩͢͜ͱͰࢥߟΛ੔ཧ
    
    ଞਓΛ൥Θͤͳ͍ 3VCCFS
    %VDLJOH “A rubber duck assisting with debugging some Java code in NetBeans.”
 © Tom Morris (Licensed under CC BY-SA 3.0)
 https://commons.wikimedia.org/wiki/File:Rubber_duck_assisting_with_debugging.jpg
20. ίετΛ౓֎ࢹ͢Ε͹
    ਓͷ΄͏͕ޮՌ͕ߴ͍
     ཧղͷఔ౓Λ؍࡯Ͱ͖Δ
     ૬ख͔Βͷ࣭໰΍ϑΟʔυόοΫ͕͋Δ
     3VCCFS
    %VDLJOH
    ΑΓ΋ʮ༉அʯ͠ͳ͍
    Ϩϙʔτͷڞ༗ͦͷ΋ͷ͕༗ҙٛ
    ͷ͸ͣ
     ࠓޙͷઃܭίʔσΟϯάϨϏϡʔΛվળͰ͖Δ
     Ϩϙʔτͷվળ͸͋͘·Ͱ΋ʮ͍ͭͰʯ 3VCCFS
    %VDLJOH
    WT
    ਓʹ࿩͢
21. ·ͣ͸෦ॺ಺޲͚ʹॻ͘
     ෦ॺ಺ͱ͍͏҆৺ײ
     ఆظϛʔςΟϯάͷϓϨογϟʔ
    ஈ֊తʹڞ༗ൣғΛ޿͛Δ
     ແཧͷͳ͍ࠩ෼
     ஈ֊͝ͱͷόοϑΝ ࣥචܧଓͷൿ݃
22. ڞ༗ϛʔςΟϯάΛຖि༵ۚʹݻఆ
     ಥવͷΩϟϯηϧ͕໎࿭ʹͳΔ
    ଟڌ఺
    ௨༁ऀ
    ॻ͔͟ΔΛಘͳ͍ঢ়گΛ࡞Δ ఆظϛʔςΟϯάͷϓϨογϟʔ
23. ීஈ͔Βͷωλ୳͠
     ίʔυϨϏϡʔͰͷؾ෇͖
     3FWJFX
    $PNNJUUFF
    ϝϯόʔͱͷࡶஊ
     աڈͷΞ΢τϓοτͷಡΈฦ͠
    ωλͷετοΫΛ
    4MBDL
    ͷ
    UJNFT
    ʹϝϞ͓ͯ͘͠ ఆظϛʔςΟϯάͷϓϨογϟʔ
    DPOU
24. ·ͣ͸෦ॺ಺޲͚ʹॻ͘
     ෦ॺ಺ͱ͍͏҆৺ײ
     ఆظϛʔςΟϯάͷϓϨογϟʔ
    ஈ֊తʹڞ༗ൣғΛ޿͛Δ
     ແཧͷͳ͍ࠩ෼
     ஈ֊͝ͱͷόοϑΝ ࣥචܧଓͷൿ݃
25. ֤ஈ֊Ͱͷʮ࠷௿ϥΠϯʯΛ௿Ίʹઃఆ ແཧͷͳ͍ࠩ෼ Slack ͷ
 ϝϞ ෦ॺ಺
 Ϩϙʔτ ࣾ಺
 Ϩϙʔτ ϒϩάهࣄ ࿩ͤ͹఻ΘΔ ೔ຊޠʹͳ͍ͬͯΔ ࣄ࣮ & ଥ౰Ͱ͋Δ ࠷௿ϥΠϯ Nice to Have ಡΈ΍͍͢
 ߏ੒/จষʹͳ͍ͬͯΔ Ϩϙʔτ͚ͩͰ
 ҙຯ͕෼͔Δ ؒҧ͍͕
 मਖ਼͞Ε͍ͯΔ ֤ஈ֊͕ʮͱΓ͋͑ͣʯ׬ྃͰ͖ΔΑ͏ʹ͢Δ
26. ·ͣ͸෦ॺ಺޲͚ʹॻ͘
     ෦ॺ಺ͱ͍͏҆৺ײ
     ఆظϛʔςΟϯάͷϓϨογϟʔ
    ஈ֊తʹڞ༗ൣғΛ޿͛Δ
     ແཧͷͳ͍ࠩ෼
     ஈ֊͝ͱͷόοϑΝ ࣥචܧଓͷൿ݃
27. ֤ஈ֊Ͱωλ΍ૉࡐΛͨΊ͓ͯ͘ ஈ֊͝ͱͷόοϑΝ Slack ͷ
 ϝϞ ෦ॺ಺
 Ϩϙʔτ ࣾ಺
 Ϩϙʔτ ϒϩάهࣄ 1 ~ 3 िؒ෼ 1 ~ 3 िؒ෼ 5 िؒ෼ ωλͷݸ਺ ෦ॺ಺
    
    ࣾ಺ڞ༗͕Ωϟϯηϧ͞Εͯ΋ϒϩάެ։ΛܧଓՄೳ
28. ·ͣ͸෦ॺ಺޲͚ʹॻ͘
     ෦ॺ಺ͱ͍͏҆৺ײ
     ఆظϛʔςΟϯάͷϓϨογϟʔ
    ஈ֊తʹڞ༗ൣғΛ޿͛Δ
     ແཧͷͳ͍ࠩ෼
     ஈ֊͝ͱͷόοϑΝ ࣥචܧଓͷൿ݃
29.  ϒϩάهࣄࣥචͷྲྀΕ
     ࣥචܧଓͷൿ݃
     Ξ΢τϓοτΛ૿΍͢ํ๏ 5PQJDT
30. Ξ΢τϓοτ͸ʮखஈʯ 
    ໨తԽ͠ͳ͍
    ໨తͷྫ
     ૊৫΁ͷ৘ใͷ஝ੵʹΑΔੜ࢈ੑͷ޲্
     ૊৫΍ݸਓͷϏδϏϦςΟ޲্
    ϦΫϧʔςΟϯά
    ίϥϘϨʔγϣϯ Ξ΢τϓοτ
    ͦͷલʹ
31. ৺ཧతϋʔυϧͱίετ
     Ͳ͏ͤΈΜͳ஌͍ͬͯΔ͜ͱͩΖ͏͠
     ॻ͍ͨ͜ͱ͕ؒҧ͍ͬͯͨΒݏͩͳ
     จষࢿྉ࡞੒͕໘౗͍͘͞
     ͕࣌ؒͳ͍ Ξ΢τϓοτͷ્֐ཁҼ ৺ཧత҆શੑ͕ߴ͍
    
    ίετ͕খ͍͞ํ๏͕ඞཁ
32. Ξ΢τϓοτͷൣғͱϑΥʔϚϧ͞ ൣғ ޿ ൣғ ڱ Ұൠެ։ ݸਓ Ո଒ ༑ਓ ٕज़ίϛϡχςΟ νʔϜ ࣾ಺ ϑΥʔϚϧ ΧδϡΞϧ ঎ۀग़൛ ͭͿ΍͖ ࡶஊ ϝϞॻ͖ ϓϨθϯςʔγϣϯ Ϩϙʔτ ϛʔςΟϯά ϒϩάهࣄ SNS ϙετ
33. ੄໺
    ڱ͍ൣғΧδϡΞϧͳΞ΢τϓοτ
    Λ૿΍͢ͱΑ͍
     Ͳ͏ͤΈΜͳ஌͍ͬͯΔ͜ͱͩΖ͏͠
    
    ˠ
    νʔϜϝϯόʔʹʮ༗༻ͳ஌ࣝͩʯͱݴͬͯ΋Β͑Δ͔΋
     ݴ͏͜ͱ͕ؒҧ͍ͬͯͨΒݏͩͳ
    ˠ
    ϨϏϡʔͯ͠΋Β͑͹҆৺͢Δ͔΋
     ͕࣌ؒͳ͍
    ˠ
    νϟοτ΍ϝϞॻ͖͔Β࢝ΊΒΕΔ͔΋ ൣғͱϑΥʔϚϧ͞ͷܦݧଇ
34. -*/&Ϡϑʔ
    ͷιϑτ΢ΣΞΤϯδχΞ
     ৽ଔ࠾༻ɾ৽ଔڭҭͷվળ
     -*/&
    $MJFOU
    "OESPJEJ04
    ͷ։ൃ
     ଞ։ൃ෦ॺͷٕज़αϙʔτ
    ϒϩά࿈ࡌ
    ίʔυ඼࣭޲্ͷςΫχοΫ
    ॻ੶
    ಡΈ΍͍͢ίʔυͷΨΠυϥΠϯ
    ΤϯδχΞνʔϜͷੜ࢈ੑͷߴΊํ .VOFUPTIJ
    *TIJLBXB
    ࠶ܝ
35. ग़ൃ఺͸ʮಉ͡આ໌Λ܁Γฦ͢ͷ͸େมʯ
     ίʔυϨϏϡʔ࣌ͷޱ಄આ໌
     ͘͝ڱ͍ൣғͰͷϓϨθϯςʔγϣϯ
     ଞ෦ॺ΍ւ֎ڌ఺΁ͷϓϨθϯςʔγϣϯ
     ࣾ಺ެࣜͷڭҭࢿྉҰൠެ։ॻ੶ࣥච <έʔεελσΟ>
    ಡΈ΍͍͢ίʔυͷΨΠυϥΠϯ Prisoner's dilemma Team productivity may decrease if we focus on the personal Eng. A ┃ │ ┃ Write clean code │ Write hacky code Eng. B ┃ │ ━━━━━━━━━━━━━━━━━━╋━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━ ┃ 8 │ 10 Write clean code ┃ │ ┃ 8 │ 1 ──────────────────╂──────────────────┼─────────────────── ┃ 1 │ 2 Write hacky code ┃ │ ┃ 10 │ 2 Introduction and Principles > Introduction Prisoner's dilemma Team productivity may decrease if we focus on the personal productivity Bob Alice Hacky Readable Readable Hacky 8 8 10 1 1 10 2 2 Introduction and Principles > Introduction
36. ͍ܰؾ࣋ͪͰͰ͖Δ͜ͱΛ஝ੵ͢Δ
     ϝϞॻ͖΍ࡶஊ
    ʮ΋͏গ͠޿͍ൣғͰ఻͑ͯΑ͍͔΋ʯͱ͍͏੠ֻ͚Λ͢Δ
     ʮͦΕɺͷൃදʹͰ͖ͦ͏ʯ
    
    ʮͷهࣄʹྑͦ͞͏ʯ
    ެ։ͷஈ֊Λઃ͚Δ
     
    ˠ
    νʔϜ
    ˠ
    ࣾ಺
    ˠ
    Ұൠެ։
     ࡶஊ
    ˠ
    ϊʔτ
    ˠ
    ϓϨθϯςʔγϣϯ Ξ΢τϓοτΛܧଓ͢Δ৺ߏ͑
37. ʮίʔυ඼࣭޲্ͷςΫχοΫʯࣥචܧଓͷൿ݃
    ఆظతͳΠϕϯτ
    ڱ͍ൣғ
    ΧδϡΞϧͳ΋ͷ͔Β
    ஈ֊తͳެ։
    ແཧͷͳ͍ࠩ෼
    ੒ՌͷόοϑΝ
    Ξ΢τϓοτҰൠ΁ͷԠ༻
    ੄໺Λ޿͛Δ
    νϟοτ΍ϝϞ
    
    ͷࡶஊͷ஝ੵ ·ͱΊ