人の役に立ちたい一心でドキュメントを改善してみたら思っていた以上に効果が出た話

Transcript

1. ਓͷ໾ʹཱ͍ͪͨҰ৺Ͱ υΩϡϝϯτΛվળͯ͠ΈͨΒ ࢥ͍ͬͯͨҎ্ʹޮՌ͕ग़ͨ࿩ API Meetup Fukuoka ؙࢁ ͻ͔Δ

2. None
3. None

4. ࣗݾ঺հ • גࣜձࣾϰΝϧݚڀॴ • ؙࢁ ͻ͔Δ • ςΫχΧϧΤόϯδΣϦετ • ਆಸ઒ݝ૬໛ݪࢢࡏॅ

5. ܦྺ 2014೥4݄ 2014೥7݄ 2015೥7݄ 2017݄1݄ ϰΝϧݚڀॴ ೖࣾ WebAPIʮӺ͢ͺ͋ͱwebαʔϏεʯ ։ൃϝϯόʔʹ ৽ػೳ։ൃ΍อकɺج൫ͷվम

   υΩϡϝϯτվળνʔϜͷҰһʹ ձࣾॳ ςΫχΧϧΤόϯδΣετʹ

6. 2014೥

7. None

8. WebAPIͷ෦ॺʹ഑ଐ • ૣ͘νʔϜʹೃછΈ͍ͨ • Կ΋෼͔Βͳ͍ɺ஌͕ࣝͳ͍

9. ͦ͏ͩɺLTΛ͠Α͏

10. ࣾ಺LT΁ͷࢀՃ • αʔϏεͷ஌ࣝΛਂΊΔͨΊʹ • Πϯϓοτ͢Δʹ͸Ξ΢τϓοτ͕Ұ൪ • ࣦഊ͢ΔͳΒࠓ͔͠ͳ͍ • ࣾ಺Ͱ݄ʹ̍ճߦΘΕΔLTʹ
 5ճ࿈ଓͰࢀՃ͢Δ͜ͱΛܾҙ

11. LT಺༰ͷ໛ࡧ ʮͦ͏͍͑͹͏ͪͷυΩϡϝϯτɺ
 ٯҾ͖ϦϑΝϨϯεతͳ΋ͷͬͯͳ͍ΜͰ͢Ͷɻ
 ྫ͑͹ɺ͋Δܦ࿏Λఆظ݊Λར༻ͯ͠৐ͬͨͱ͖ͷ
 ӡ௞ܭࢉ͕͍ͨ࣌͠ʹɺAPIͷ࢓༷͔Β
 ࣗ෼Ͱ୳͞ͳ͍ͱ͍͚ͳ͍ΜͰ͢Ͷɻʯ ʮ͔֬ʹݴΘΕͯΈΕ͹ͦ͏ͩͶɻ͏ͪͷWebAPIͬͯ
 ࢖͍ํ͕ෳࡶ͔ͩΒɺ͋ΔͱศརͩͶɻʯ

12. ͦΕͩʂ

13. • ࣾһͷ൓Ԡ • ؒ઀తͳϑΟʔυόοΫ • ࣾ಺Ͱ
 Ӻ͢ͺ͋ͱWebαʔϏεʹ ؙࢁʁ
 • WebAPIͷֶͼ

    • ௚ײతͰͳ্͍ʹ
 υΩϡϝϯτ΋؆ૉ • Ӻ͢ͺ͋ͱWebαʔϏεʹ Θ͔ΓͮΒ͍WebAPI

14. 2015೥

15. ;ͱͨ͠ձ࿩͔Β ʮSSLରԠ͔ͨ͠ΒυΩϡϝϯταΠτʹࡌ͓͍ͤͯͯʔʯ ʮͲ͜ʹࡌͤΔΜͰ͔͢ɻࠓ͸APIͷ࢓༷͔͠ࡌͤͯͳ͍͔Βɺࡌͤ Δͱͨ͠Β৽͘͠ίϯςϯπΛ࡞Δඞཁ͕͋ΔΜ͡Όͳ͍Ͱ͔͢ʁʯ ʮ͔֬ʹಋೖ෦෼ͷ໰͍߹Θͤ΋ଟ͍͠ʲελʔτΞοϓΨΠυʳͱ ͔ཉ͍͠Ͷ͑ʯ ʮSSLରԠͷ݅͸ʲΑ͋͘Δ͓໰͍߹ΘͤʳͰٵऩͰ͖ͦ͏Ͱ͢ Ͷʂʯ ʮίϯςϯπΛ૿΍͢ͳΒɺӦۀͱαϙʔτʹ૬ஊͯ͠ΈͨΒʁ
 Ϣʔβͷ૭ޱʹͳͬͯΔ͔Βʯ

16. ͦΕͩʂ(2ճ໨)

17. υΩϡϝϯτվળʹ औΓ૊Ή͜ͱʹ

18. υΩϡϝϯτվળνʔϜ݁੒ • ݁੒ͷܦҢ • Ӧۀ෦ॺͷਓʹ૬ஊͨ͠Βɺʮੋඇ΍Γ͍ͨʂʯͱݴ͏ਓΛ
 ঺հͯ͘͠Εͨ • Ӧۀ෦ॺͷਓ͕αϙʔτ෦ॺͷਓΛݺΜͰ͘Εͨ • νʔϜฤ੒

    • Ӻ͢ͺ͋ͱwebαʔϏεͷӦۀΛ୲౰͢Δ෦ॺɹɹɿ1ਓ • Ӻ͢ͺ͋ͱwebαʔϏεͷαϙʔτΛ୲౰͢Δ෦ॺɿ1ਓ • Ӻ͢ͺ͋ͱwebαʔϏεͷ։ൃΛ୲౰͢Δ෦ॺɹɹɿ1ਓ • ӡ༻ • ݄1ճͷఆྫMTG • ໨త • Ӻ͢ͺ͋ͱwebαʔϏεͷՁ஋޲্

19. ԿΛվળ͢Δʁ

20. ࠷௿ͳWebAPIυΩϡϝϯτ

21. • ΢ι͹͔ͬΓ • ߋ৽͞Εͳ͍ • ߋ৽ཤྺ͕ͳ͍ • ઐ໳༻ޠͷઆ໌ͳ͠ • ౷Ұੑ͕ͳ͍

    • ٯҾ͖͕ͳ͍ • ཉ͍͠৘ใ͕ݟ͔ͭΒͳ͍ • ԿΛ࢖ͬͨΒ͓͔͔ۚΔ͔෼͔Βͳ͍ • ԿΛ࢖͑Δͷ͔෼͔Βͳ͍ • ϑϦʔϓϥϯ/ελϯμʔυϓϥϯͷυΩϡϝϯταΠτ͕ࠅࣅ͍ͯͯ͠
 ۠ผ͠ʹ͍͘ ࠷௿ͳWebAPIυΩϡϝϯτ

22. ඇΤϯδχΞͱҰॹʹ GithubͰ؅ཧ • όʔδϣϯ؅ཧ͞Ε͍ͯͳ͔ͬͨυΩϡϝϯτͷιʔείʔυΛ Github؅ཧԼʹ • υΩϡϝϯτվળνʔϜʹGithubͰϓϧϦΫΛ֬ೝͯ͠΄͍͠ͱએݴ • ͢ΜͳΓOK͞ΕɺΞΧ΢ϯτΛऔಘͯ͠΋Β͏ •

    ஸೡͳϨΫνϟʔ • ϓϧϦΫͷ֬ೝํ๏ • ίϝϯτͷ࢓ํ • ઈରʹԡͪ͠Ό͍͚ͳ͍Ϙλϯ (mergeϘλϯ)

23. ςεταΠτͷ༻ҙ • ඇΤϯδχΞ͕GithubͰϓϧϦΫΛ
 ֬ೝͯ͠΋Β͍΍͘͢͢ΔͨΊ • ιʔείʔυ͚ͩͩͱɺϨΠΞ΢τ͕བྷΉ
 ϓϧϦΫΛ֬ೝ͢Δ͜ͱ͕Ͱ͖ͳ͍ • AWS S3ʹςεταΠτ༻ͷBucketΛ༻ҙ͠ɺ

    ࡞ۀϒϥϯνͷ಺༰Λ൓өͤͨ͞

24. ࣗಈσϓϩΠ • ϓϧϦΫ͕Ϛʔδ͞ΕΔͨͼʹɺຖճAWS S3ʹ खಈͰϑΝΠϧΛΞοϓϩʔυ͢Δͷ͸
 ໘౗͍҆͘͞͠શ͡Όͳ͍ • Wercker(CIπʔϧ)Λ࢖ͬͯ
 σϓϩΠࣗಈԽͷઃఆΛߦ͏ •

    ࡞ۀ͕அવָʹ

25. ੩తαΠτδΣωϨʔλಋೖ • ໰୊͕ੵΈ্͕͍ͬͯͨ • googleΞφϦςΟΫε΍ΞϯέʔτϑΥʔϜΛҰ෦ͷ ϖʔδʹ͔͠औΓೖΕΒΕͳ͍ • ૉͷhtmlΛվม͠ଓ͚Δ͜ͱ͸݈શͰ͸ͳ͍ • υΩϡϝϯτ͸markdownͰ؅ཧ͍ͨ͠

    • middlemanಋೖ • html͔Βmarkdown΁ͷม׵͸खͰߦͬͨ(൓ল఺)

26. վળͷޮՌ

27. ։ൃαϙʔτۀ຿ͷܰݮ • νέοτ਺ͷਪҠ • 39ظ(վળલ)ͷ߹ܭɿ178 • 40ظ(վળޙ)ͷ߹ܭɿ141 → 20%ݮ

28. Ϣʔβ΁ͷฦ৴͕εϜʔζʹ

29. Ϣʔβ͔ΒϑΟʔυόοΫ • υΩϡϝϯτ͕Θ͔Γ΍͍͢͜ͱͰɺϢʔβͷ ։ൃίετ͕ܰݮ • ಋೖࣄྫͰυΩϡϝϯτ͕๙ΊΒΕΔΑ͏ʹ

30. ΍ͬͨͥʂ

31. υΩϡϝϯτվળͯ͠Έͯ • Ϣʔβ͔ΒͷϑΟʔυόοΫ͕Ϟνϕʔγϣϯʹ • αϙʔτରԠ࣌ؒΛଞͷ͜ͱʹ࢖͑Δ • औΓ૊ΉதͰ஌͕ࣝ૿͑ͨ

32. ͦΕҎ֎ʹ • υΩϡϝϯτ͕ྑ͘ͳ͚ͬͨͩͰ͸ͳ͘ • νʔϜͷதͰ΋ɺࢲҎ֎ʹυΩϡϝϯτͷ
 ϓϧϦΫΛࣗओతʹग़ͯ͘͠ΕΔ • ։ൃҎ֎ͷਓͱू·Δ͕࣌ؒ૿͑ɺ
 ৘ใڞ༗ͷ৔ͱͳͬͨ

33. ৼΓฦͬͯΈΔͱ

34. Կ΋෼͔Βͳ͔ͬͨ࣌ • Ͱ͖ͦ͏ͳ͜ͱ͔Β΍ͬͯΈͨ • ࣾ಺LT • ஌ࣝͷٵऩ଎౓ • ࣾһͱͷձ࿩͕ੜ·ΕΔ •

    υΩϡϝϯτվળʹͭͳ͕ͬͨ • …etc

35. Thank you!

36. ͓ؼΓͷࡍ͸ Ӻ͢ͺ͋ͱΞϓϦͰ