Upgrade to Pro — share decks privately, control downloads, hide ads and more …

ドキュメント改善の仕組みづくり / DevRel Meetup in Tokyo #23

ドキュメント改善の仕組みづくり / DevRel Meetup in Tokyo #23

HikaruMaruyama

September 06, 2017
Tweet

More Decks by HikaruMaruyama

Other Decks in Programming

Transcript

  1. 2017/9/5 DevRel Meetup in Tokyo #23
    גࣜձࣾϰΝϧݚڀॴ ؙࢁͻ͔Δ
    υΩϡϝϯτվળͷ
    ࢓૊Έͮ͘Γ

    View Slide

  2. Profile
    ؙࢁͻ͔Δ
    גࣜձࣾϰΝϧݚڀॴ
    ςΫχΧϧΤόϯδΣϦετ
    ਆಸ઒ݝ૬໛ݪࢢࡏॅ
    IJLBSVNBSVZBNB
    !NBSVZBNBIJBLSV
    IUUQIJJJJJJJIJLBSVIBUFOBEJBSZDPN

    View Slide

  3. 1988೥ ࠃ಺ॳͷ৐׵Ҋ಺ιϑτ
    Ӻ͢ͺ͋ͱ ͕஀ੜ͠·ͨ͠ɻ
    ݸਓར༻͚ͩͰ͸ͳ͘ɺ
    ϏδωεγʔϯͰ΋਺ଟ͘ͷ
    ࠾༻࣮੷͕͋Γ·͢ɻ
    Έͳ͞Μ͝ଘ஌ Yahoo࿏ઢਤ ΋
    Ӻ͢ͺ͋ͱͷΤϯδϯͰ͢ɻ
    “৐׵Ҋ಺”ͷձࣾͰ͢

    View Slide

  4. “Ӻ͢ͺ͋ͱ”ͷWebAPI
    Ӻ͢ͺ͋ͱWebαʔϏε

    View Slide

  5. Ӻ͢ͺ͋ͱwebαʔϏεͰ͸ɺ
    APIͷ࢓༷΍αϯϓϧίʔυ͕ஔ͍ͯ͋Δ
    υΩϡϝϯταΠτ
    (http://docs.ekispert.com/v1/)
    Λެ։͍ͯ͠·͢ɻ
    2015೥͔ΒݱࡏʹࢸΔ·Ͱɺ
    ϢʔβʹΑΓศརʹ࢖ͬͯ΋Β͑ΔΑ͏ʹ
    νʔϜΛ݁੒ͯ͠վળ׆ಈΛߦ͍ͬͯ·͢ɻ

    View Slide

  6. ࠓ೔ͷຊ୊ɿ
    ࠓͰ΋ܧଓతʹυΩϡϝϯτվળ͕
    ߦ͍͑ͯΔ͠ɺ
    ͳ͔ͳ͔͍͍ײ͡ʹճͬͯΔײ͕͢͡ΔͷͰ
    ͏ͪͰऔΓ૊ΜͰ͍Δ
    վળͷ࢓૊Έʹ͍͓ͭͯ࿩͠·͢ɻ

    View Slide

  7. ·ͣɿ
    վળͯ͠Կ͕Ͳ͏ྑ͘ͳͬͨͷ͔ʁ

    View Slide

  8. Before
    ݹष͍σβΠϯͩʜ
    "1*ͷ࢓༷͔͠
    ࡌ͍ͬͯͳ͍ʜ

    View Slide

  9. After
    Ϩεϙϯγϒ
    σβΠϯͩʂ
    "1*ͷ࢓༷͚ͩͰ͸ͳ͘
    5JQT΍'"2ͳͲ
    ίϯςϯπ΋૿͑ͯΔʂ

    View Slide

  10. ྑ͘ͳͬͨͦͷ1.
    ίϯςϯπΛ֦ॆͯ͠Ϣʔβͷ໾ʹͨͯͨ
    • Ϣʔβ͔ΒΑ͓͘໰͍߹ΘͤΛ௖͍͍ͯͨ಺༰Λ

    Tips΍FAQͳͲͷ߲໨Ͱٵऩ
    • υΩϡϝϯτ͕Θ͔Γ΍͍͢͜ͱͰɺ

    Ϣʔβͷ։ൃίετ͕ܰݮ
    • υΩϡϝϯτ͕ܾΊखͰ

    Ӻ͢ͺ͋ͱwebαʔϏεΛબΜͰ͘Εͨέʔε΋
    • ಋೖࣄྫͰ

    υΩϡϝϯτ͕๙ΊΒΕΔΑ͏ʹͳͬͨ

    View Slide

  11. ྑ͘ͳͬͨͦͷ2.
    υΩϡϝϯτʹ৘ใΛू໿͢Δ͜ͱͰ
    ۀ຿ָ͕ʹͳͬͨ
    Ӧۀଆ
    • ʮఆظ߇আͷखॱʯʹ͍ͭͯϢʔβ͔Β໰͍߹ΘͤΛड͚ͨࡍʹɺ

    ࠓ·ͰͩͬͨΒAPIͷϦΫΤετύϥϝʔλྫͳͲΛهड़ͯ͠

    આ໌Λߦ͍ͬͯͨͷͰɺखؒͱ͕͔͔͍࣌ؒͬͯͨ
    • ࠓ͸ɺʮఆظ݊ར༻࣌ͷӡ௞ܭࢉʯϖʔδͷURLΛҊ಺͢Δ͚ͩͰɺ

    త͔֬ͭਝ଎ͳฦ৴͕Ͱ͖ΔΑ͏ʹͳͬͨ
    ։ൃଆ
    • Ӧۀ/αϙʔτ͔ΒΤεΧϨʔγϣϯ͢Δαϙʔτۀ຿͕ɺ

    վળલͱվળޙͰ໿20%ݮ
    • υΩϡϝϯτʹίϯςϯπΛ֦ॆ͔ͯ͠Βɺ

    ಉ͡Α͏ͳ಺༰ͷ໰͍߹Θͤ͸গͳ͘ͳͬͨ

    View Slide

  12. υΩϡϝϯτͷվળ׆ಈ͸
    ੒Ռ͕ग़ͨΈ͍ͨͩ

    View Slide

  13. υΩϡϝϯτվળ͸
    ͳͥ͏·͍ͬͨ͘ͷ͔
    ࠓ·Ͱ΍͖ͬͯͨ͜ͱΛৼΓฦͬͯΈͨ

    View Slide

  14. খ͍͞νʔϜΛ
    ࡞Δ
    ؔ܎ऀΛ
    ἧ͑Δ
    ఆྫձٞΛ
    ઃ͚Δ
    ܧଓతʹ
    ϦϦʔε͢Δ

    View Slide

  15. খ͍͞νʔϜΛ
    ࡞Δ
    ؔ܎ऀΛ
    ἧ͑Δ
    ఆྫձٞΛ
    ઃ͚Δ
    ܧଓతʹ
    ϦϦʔε͢Δ

    View Slide

  16. খ͍͞νʔϜΛ࡞Δ
    খ͍͞νʔϜͷϝϦοτ
    • ૉૣ͍৘ใڞ༗ͱҙࢥܾఆ
    • ॊೈͳํ޲స׵
    • ίϛϡχέʔγϣϯָ͕
    Ӻ͢ͺ͋ͱwebαʔϏε ͷ৔߹
    ܭ3໊ͷʮυΩϡϝϯτվળνʔϜʯΛ݁੒͠ɺ

    ͦͷνʔϜͷϝϯόʔ͕த৺ͱͳΓυΩϡϝϯτͷվળΛߦͬͨ

    View Slide

  17. খ͍͞νʔϜΛ
    ࡞Δ
    ؔ܎ऀΛ
    ἧ͑Δ
    ఆྫձٞΛ
    ઃ͚Δ
    ܧଓతʹ
    ϦϦʔε͢Δ

    View Slide

  18. ؔ܎ऀΛἧ͑Δ
    ग़໭ΓΛ๷͙
    ։ൃ෦ॺͷਓ͚ؒͩ/Ӧۀ෦ॺͷਓ͚ؒͩ ͷɺ

    ภͬͨϝϯόʔฤ੒͸ग़໭ΓΛੜΉ
    ӦۀʮϢʔβʹͦΜͳઆ໌ͷ࢓ํ͸͍ͯ͠ͳ͍ʯ

    ։ൃʮυΩϡϝϯτʹهࡌ͞Ε͍ͯΔ࢓༷͕ؒҧ͍ͬͯΔʯ
    Ӻ͢ͺ͋ͱWebαʔϏε ͷ৔߹
    ௚઀Ϣʔβͷ੠Λฉ͘ਓ(Ӧۀɺαϙʔτ෦ॺ)ͱɺ

    υΩϡϝϯταΠτʹ൓ө͢Δਓ(։ൃ෦ॺ)ΛϝϯόʔʹೖΕͨ

    View Slide

  19. খ͍͞νʔϜΛ
    ࡞Δ
    ؔ܎ऀΛ
    ἧ͑Δ
    ఆྫձٞΛ
    ઃ͚Δ
    ܧଓతʹ
    ϦϦʔε͢Δ

    View Slide

  20. ఆྫձٞΛઃ͚Δ
    վળ͠ଓ͚Δ޻෉
    վળ͸ࣗ෼ͨͪΛָʹ͢Δ͜ͱ͕Ͱ͖Δ

    վળΛࢭΊͯ͠·͏ͱ…?
    վળΛ࣋ଓ͢ΔͨΊʹɺཱͪࢭ·ΔػձΛڧ੍తʹઃ͚Δ
    Ӻ͢ͺ͋ͱWebαʔϏε ͷ৔߹
    ݄1ճͷఆྫϛʔςΟϯάΛ։࠵

    View Slide

  21. খ͍͞νʔϜΛ
    ࡞Δ
    ؔ܎ऀΛ
    ἧ͑Δ
    ఆྫձٞΛ
    ઃ͚Δ
    ܧଓతʹ
    ϦϦʔε͢Δ

    View Slide

  22. ܧଓతʹϦϦʔε͢Δ
    ϞνϕʔγϣϯΛ࣋ଓͤ͞Δ
    Ϟνϕʔγϣϯ্͕͕Βͳ͍վળ͸ɺ

    ్தͰ΍Ίͨ͘ͳΔ
    ͦ͏ͳΒͳ͍ͨΊʹɺখ͞ͳ੒ޭମݧΛੵΈॏͶͯɺ

    ϞνϕʔγϣϯΛ࣋ଓͤ͞Δ
    Ӻ͢ͺ͋ͱWebαʔϏε ͷ৔߹
    λεΫΛ෼ղͯ͠খ͘͞ϦϦʔεɺͦΕΛͪΐͪ͜ΐ͜ͱ

    খ͘͞ϦϦʔε͢Δ͜ͱ͕ۤʹͳΒͳ͍Α͏ʹσϓϩΠ؀ڥΛ੔උ

    View Slide

  23. খ͍͞νʔϜΛ
    ࡞Δ
    ؔ܎ऀΛ
    ἧ͑Δ
    ఆྫձٞΛ
    ઃ͚Δ
    ܧଓతʹ
    ϦϦʔε͢Δ

    View Slide

  24. ؔ܎ऀΛूΊͨখ͞ͳνʔϜΛ࡞Δ͜ͱͰɺ
    ग़໭Γ΍ίϛϡχέʔγϣϯίετΛ

    ۃྗഉআ͠ɺ

    ޮ཰తʹվળΛਐΊΔ͜ͱ͕Ͱ͖ͨ
    Good!

    View Slide

  25. ͨͩ͠ɺগਓ਺੍͸
    ଐਓԽΛੜΉՄೳੑ͋Γ
    গͣͭ͠ੈ୅ަ୅Λ͢Δͷ͕݈શ͔΋
    Bad…

    View Slide

  26. ੈ୅ަ୅ΛਤΔͨΊɺ
    Ӻ͢ͺ͋ͱwebαʔϏεͷ։ൃ෦ॺʹ

    ഑ଐ͞Εͨ৽ਓΛ౤ೖͯ͠Έ͍ͯΔɻ
    ྑ͍νʔϜͷঢ়ଶΛ่ͣ͞ʹɺ
    ਓΛগͣͭ͠ϩʔςʔγϣϯ͍ͯ͘͠ͷ͕ཧ૝ɻ
    Hmm.

    View Slide

  27. Thank you

    View Slide