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

by HikaruMaruyama

Slide 1

Slide 1 text

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

Slide 2

Slide 2 text

No content

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

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

Slide 5

Slide 5 text

ܦྺ 2014೥4݄ 2014೥7݄ 2015೥7݄ 2017݄1݄ ϰΝϧݚڀॴ ೖࣾ WebAPIʮӺ͢ͺ͋ͱwebαʔϏεʯ ։ൃϝϯόʔʹ ৽ػೳ։ൃ΍อकɺج൫ͷվम υΩϡϝϯτվળνʔϜͷҰһʹ ձࣾॳ ςΫχΧϧΤόϯδΣετʹ

Slide 6

Slide 6 text

2014೥

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

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

Slide 9

Slide 9 text

ͦ͏ͩɺLTΛ͠Α͏

Slide 10

Slide 10 text

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

Slide 11

Slide 11 text

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

Slide 12

Slide 12 text

ͦΕͩʂ

Slide 13

Slide 13 text

• ࣾһͷ൓Ԡ • ؒ઀తͳϑΟʔυόοΫ • ࣾ಺Ͱ  Ӻ͢ͺ͋ͱWebαʔϏεʹ ؙࢁʁ  • WebAPIͷֶͼ • ௚ײతͰͳ্͍ʹ  υΩϡϝϯτ΋؆ૉ • Ӻ͢ͺ͋ͱWebαʔϏεʹ Θ͔ΓͮΒ͍WebAPI

Slide 14

Slide 14 text

2015೥

Slide 15

Slide 15 text

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

Slide 16

Slide 16 text

ͦΕͩʂ(2ճ໨)

Slide 17

Slide 17 text

υΩϡϝϯτվળʹ औΓ૊Ή͜ͱʹ

Slide 18

Slide 18 text

υΩϡϝϯτվળνʔϜ݁੒ • ݁੒ͷܦҢ • Ӧۀ෦ॺͷਓʹ૬ஊͨ͠Βɺʮੋඇ΍Γ͍ͨʂʯͱݴ͏ਓΛ  ঺հͯ͘͠Εͨ • Ӧۀ෦ॺͷਓ͕αϙʔτ෦ॺͷਓΛݺΜͰ͘Εͨ • νʔϜฤ੒ • Ӻ͢ͺ͋ͱwebαʔϏεͷӦۀΛ୲౰͢Δ෦ॺɹɹɿ1ਓ • Ӻ͢ͺ͋ͱwebαʔϏεͷαϙʔτΛ୲౰͢Δ෦ॺɿ1ਓ • Ӻ͢ͺ͋ͱwebαʔϏεͷ։ൃΛ୲౰͢Δ෦ॺɹɹɿ1ਓ • ӡ༻ • ݄1ճͷఆྫMTG • ໨త • Ӻ͢ͺ͋ͱwebαʔϏεͷՁ஋޲্

Slide 19

Slide 19 text

ԿΛվળ͢Δʁ

Slide 20

Slide 20 text

࠷௿ͳWebAPIυΩϡϝϯτ

Slide 21

Slide 21 text

• ΢ι͹͔ͬΓ • ߋ৽͞Εͳ͍ • ߋ৽ཤྺ͕ͳ͍ • ઐ໳༻ޠͷઆ໌ͳ͠ • ౷Ұੑ͕ͳ͍ • ٯҾ͖͕ͳ͍ • ཉ͍͠৘ใ͕ݟ͔ͭΒͳ͍ • ԿΛ࢖ͬͨΒ͓͔͔ۚΔ͔෼͔Βͳ͍ • ԿΛ࢖͑Δͷ͔෼͔Βͳ͍ • ϑϦʔϓϥϯ/ελϯμʔυϓϥϯͷυΩϡϝϯταΠτ͕ࠅࣅ͍ͯͯ͠  ۠ผ͠ʹ͍͘ ࠷௿ͳWebAPIυΩϡϝϯτ

Slide 22

Slide 22 text

ඇΤϯδχΞͱҰॹʹ GithubͰ؅ཧ • όʔδϣϯ؅ཧ͞Ε͍ͯͳ͔ͬͨυΩϡϝϯτͷιʔείʔυΛ Github؅ཧԼʹ • υΩϡϝϯτվળνʔϜʹGithubͰϓϧϦΫΛ֬ೝͯ͠΄͍͠ͱએݴ • ͢ΜͳΓOK͞ΕɺΞΧ΢ϯτΛऔಘͯ͠΋Β͏ • ஸೡͳϨΫνϟʔ • ϓϧϦΫͷ֬ೝํ๏ • ίϝϯτͷ࢓ํ • ઈରʹԡͪ͠Ό͍͚ͳ͍Ϙλϯ (mergeϘλϯ)

Slide 23

Slide 23 text

ςεταΠτͷ༻ҙ • ඇΤϯδχΞ͕GithubͰϓϧϦΫΛ  ֬ೝͯ͠΋Β͍΍͘͢͢ΔͨΊ • ιʔείʔυ͚ͩͩͱɺϨΠΞ΢τ͕བྷΉ  ϓϧϦΫΛ֬ೝ͢Δ͜ͱ͕Ͱ͖ͳ͍ • AWS S3ʹςεταΠτ༻ͷBucketΛ༻ҙ͠ɺ ࡞ۀϒϥϯνͷ಺༰Λ൓өͤͨ͞

Slide 24

Slide 24 text

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

Slide 25

Slide 25 text

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

Slide 26

Slide 26 text

վળͷޮՌ

Slide 27

Slide 27 text

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

Slide 28

Slide 28 text

Ϣʔβ΁ͷฦ৴͕εϜʔζʹ

Slide 29

Slide 29 text

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

Slide 30

Slide 30 text

΍ͬͨͥʂ

Slide 31

Slide 31 text

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

Slide 32

Slide 32 text

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

Slide 33

Slide 33 text

ৼΓฦͬͯΈΔͱ

Slide 34

Slide 34 text

Կ΋෼͔Βͳ͔ͬͨ࣌ • Ͱ͖ͦ͏ͳ͜ͱ͔Β΍ͬͯΈͨ • ࣾ಺LT • ஌ࣝͷٵऩ଎౓ • ࣾһͱͷձ࿩͕ੜ·ΕΔ • υΩϡϝϯτվળʹͭͳ͕ͬͨ • …etc

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

Slide 7

Slide 7 text

Slide 8

Slide 8 text

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

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

Slide 30

Slide 30 text

Slide 31

Slide 31 text

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