プロダクトのドキュメント更新をチームに根付かせる

XP祭り2022
Cトラック 15:00~15:20

https://xpjug.connpass.com/event/255712/

Transcript

1. ϓϩμΫτͷυΩϡϝϯτߋ৽ΛνʔϜʹࠜ෇͔ͤΔ 5XJUUFSɿ!NPOPIBTIJLB ,BNP 91ࡇΓ  
2. ,BNP ૊৫΍ෳ਺ϓϩμΫτͷࠔΓࣄʢো֐෺ʣΛ ԣஅతʹղܾ͍ͯ͘͠࢓ࣄΛ͍ͯ͠Δਓ %FMJWFSZ
   .BOBHFS
   㲈 4DSVN
   .BTUFS  1SPEVDU
   .BOBHFS
    1SPKFDU
   .BOBHFS
    &OHJOFFS
3. ࠓ೔ͷςʔϚ ϓϩμΫτͷυΩϡϝϯτ͸ ߋ৽Ͱ͖ͯ·͔͢ʁ ߋ৽Ͱ͖͍ͯͳͯ͘΋ɺͲ͏ʹ͔ͳ͍ͬͯΔΑ͏ͳؾ΋͢Δ͕ ϝϯόʔ͕૿ݮ͢ΔλΠϛϯάͰɺ৘ใڞ༗ͷ՝୊ͱ͕ͯ͋͠Δέʔε͕ଟ͍ɻ Α͋͘Δ՝୊ʢ8IZʣͱ࣮ࢪ͍ͯ͠Δղܾࡦʢ8IBUʣͷ͍͔ͭ͘Λ঺հɻ ۩ମతͳ΍Γํʢ)PXʣ͸࣌ؒͷؔ܎্ׂѪ͠·͢
4. ࠓ೔ͷ՝୊ ϓϩμΫτͷυΩϡϝϯτΛ ͏·͘ߋ৽͍ͯ͘͠ʹ͸ʁ Ξϓϩʔν
   ϓϩμΫτͷυΩϡϝϯτߋ৽ͷਐΊํ Ξϓϩʔν
   ϓϩμΫτͷυΩϡϝϯτΛߋ৽͠΍͘͢͢ΔͨΊͷ෼ྨ
5. ࠓ೔ͷղܾࡦ "
   ʮࠓޙ΋֬ೝ͢ΔՄೳੑ͕͋Δ͔ʯͰ෼ྨ͠Α͏ɻ "
   ʮνʔϜͰߋ৽͋͑͠Δงғؾɾঢ়گʯΛ࡞Ζ͏ɻ
6. 
   ϓϩμΫτͷυΩϡϝϯτΛ ߋ৽͠΍͘͢͢ΔͨΊͷ෼ྨ
7. ϓϩμΫτͷυΩϡϝϯτΛߋ৽͢ΔࡍͷΑ͋͘Δ՝୊ υΩϡϝϯτ͸࣌ؒܦաͱͱ΋ʹ૿͑ଓ͚ɺ৘ใ୳ࡧʹؔ͢Δ໰୊Λൃੜͤ͞Δɻ υΩϡϝϯτͷఆظతͳ୨Է͕ඞཁ͕ͩɺ֤ࣗͷ౒ྗͰ͸ݶք͕͋Δɻ ࠷৽ͷ࢓༷΍खॱͷ֬ೝ͕େม wυΩϡϝϯτ͕࠷৽͔Θ͔Βͳ͍ɻ w৽ϝϯόʔ͕৘ใΛಘΔͨΊʹ͸ਓʹฉ͔͘ɺίʔυΛݟΔ͔ɻ w஌͍ͬͯΔਓ͕ୀ৬ͨ͠ɻ
8. ϓϩδΣΫτͷऴΘΓʹ ʮࠓޙ΋֬ೝ͢ΔՄೳੑ͕͋Δ͔ͳ͍͔ʯͷ࣠Ͱ୨ԷΛߦ͏ɻ ࠓޙϝϯςφϯεͷର৅ͱ͢ΔυΩϡϝϯτΛϓϩμΫτͷυΩϡϝϯτʹݶఆ͢Δɻ ϓϩμΫτͷυΩϡϝϯτ ϓϩδΣΫτͷυΩϡϝϯτ ࠓޙ΋֬ೝ͢ΔՄೳੑ͕͋Δ ࠓޙ͸֬ೝ͢ΔՄೳੑ͕ͳ͍ ྫɿ wϩʔυϚοϓ wܾఆͨ͠࢓༷ wఆৗతͳσϓϩΠखॱ ྫ w࡞ۀεέδϡʔϧ w࢓༷ͷީิ wΞυϗοΫͳ࡞ۀखॱ ϓϩμΫτͷυΩϡϝϯτΛߋ৽͢Δࡍͷ՝୊ͷղܾࡦ υΩϡϝϯτͷ૿Ճྔɿେ υΩϡϝϯτͷ૿Ճྔɿখ
9. ϓϩμΫτͷυΩϡϝϯτΛ෼ྨ͠΍͍͢ঢ়گΛ࡞Δࣄྫ υΩϡϝϯτͷ෼ྨ΍ϑΥʔϚοτΛௐ੔͠ɺ৘ใΛҠಈ͠΍͍͢Α͏ʹ͓ͯ͘͠ɻ ϓϩδΣΫτͷ׬ྃ࣌ʹࠓޙ΋֬ೝ͢ΔՄೳੑ͕͋Δ৘ใ͸Ҡಈ͢Δɻ ϓϩμΫτͷυΩϡϝϯτ ϓϩδΣΫτͷυΩϡϝϯτ ϓϩδΣΫτ"ɿ$MPTFE ϓϩδΣΫτ#ɿ%POF ϓϩδΣΫτ$ɿ%PJOH ϓϩδΣΫτ%ɿ%PJOH ཁ݅ ը໘ઃܭ ཁ݅ ը໘ઃܭ ࠓޙ΋֬ೝ͢Δ Մೳੑ͕͋Δ৘ใ ࠓޙ͸֬ೝ͢Δ Մೳੑ͕ͳ͍৘ใ  ඞཁʹԠͯ͡৘ใΛίϐʔ 
10. 
    ϓϩμΫτͷ υΩϡϝϯτߋ৽ͷਐΊํ
11. ϓϩμΫτͷυΩϡϝϯτΛߋ৽͢ΔࡍͷΑ͋͘Δ՝୊ νʔϜʹΑΔυΩϡϝϯτߋ৽ʹ͸ɺ৺ཧతͳϋʔυϧʹىҼ͢Δ໰୊͕ൃੜ͢Δɻ ʮνʔϜϝϯόʔʹฉ͚͹ྑ͍ʯͰ͸ɺղܾ͕ਐ·ͳ͍৔߹͕͋Δɻ ࣅͨΑ͏ͳυΩϡϝϯτ͕૿͑Δ ࡞੒ऀʹߋ৽ґཔ͕͘Δ wυΩϡϝϯτ͕͋Δ͜ͱΛ஌Βͳ͍ɻ wυΩϡϝϯτΛΑΓྑ͍ͨ͘͠ɻ wଞਓͷυΩϡϝϯτΛߋ৽ͯ͠ྑ͍͔Θ͔Βͳ͍ɻ wυΩϡϝϯτͷॻ͖ํ͕Θ͔Βͳ͍ɻ w͏·͘मਖ਼Ͱ͖Δ͔͕ෆ҆ɻ
12. ϓϩμΫτͷυΩϡϝϯτΛߋ৽͢Δࡍͷ՝୊ͷղܾࡦ υΩϡϝϯτߋ৽ͷ৺ཧతͳϋʔυϧΛ௿ݮ͢ΔͨΊͷϓϥΫςΟε͸୳͠ʹ͍͘ɻ ϓϩάϥϜͷίʔσΟϯάʹؔ͢ΔϓϥΫςΟεΛ׆༻͢Δɻ υΩϡϝϯτߋ৽࣌ͷ໰୊ ׆༻Ͱ͖ΔίʔσΟϯάͷϓϥΫςΟε wυΩϡϝϯτ͕͋Δ͜ͱΛ஌Βͳ͍ɻ wଞਓͷυΩϡϝϯτΛߋ৽ͯ͠ྑ͍͔Θ͔ Βͳ͍ɻ Ϟϒϓϩάϥϛϯά wυΩϡϝϯτͷॻ͖ํ͕Θ͔Βͳ͍ɻ ϖΞϓϩάϥϛϯά wυΩϡϝϯτΛΑΓྑ͍ͨ͘͠ɻ ϦϑΝΫλϦϯά w͏·͘मਖ਼Ͱ͖Δ͔͕ෆ҆ɻ 1VMM
    3FRVFTU
13. ϓϩμΫτͷυΩϡϝϯτΛߋ৽͢Δงғؾɾঢ়گΛ࡞Δ ίʔσΟϯάͷϓϥΫςΟεʹ͸ νʔϜͰίʔυΛߋ৽͢Δงғؾɾঢ়گΛܗ੒͢Δ΋ͷ͕͋Δɻ ίʔσΟϯάͷϓϥΫςΟεΛ༻͍Δ͜ͱͰɺ υΩϡϝϯςʔγϣϯʹରͯ͠΋ɺνʔϜͰߋ৽͢Δงғؾɾঢ়گΛ࡞Γ΍͍͢ɻ
14. ·ͱΊ ϓϩμΫτͷυΩϡϝϯτΛνʔϜͰߋ৽͢ΔͨΊͷ͍͔ͭ͘ͷղܾࡦͷ঺հ 
    ϓϩμΫτͷυΩϡϝϯτߋ৽ͷਐΊํ 
    ϓϩμΫτͷυΩϡϝϯτΛߋ৽͠΍͘͢͢Δ෼ྨ "
    ʮࠓޙ΋֬ೝ͢ΔՄೳੑ͕͋Δ͔ʯͰ෼ྨ͠Α͏ɻ "
    ʮνʔϜͰߋ৽͋͑͠Δงғؾɾঢ়گʯΛͭ͘Ζ͏ɻ