ドキュメントを修正する

株式会社リンカーズさんの社内勉強会で発表したLTのスライドです

Transcript

1. υΩϡϝϯτΛमਖ਼͢Δ
   @willnet
   

   View Slide

2. ීஈͷ։ൃɺͳΜΒ͔ͷυΩϡϝϯτ
   Λݟͳ͕Β։ൃ͠·͢ΑͶ
   

   View Slide

3. OSSͷυΩϡϝϯτͷؒҧ͍Λݟ͚ͭͨΒͲ͏͠
   ·͔͢ʁ
   1. εϧʔ
   2. ؒҧ͍Λमਖ਼͢Δɺใࠂ͢Δ
   

   View Slide

4. OSSͷυΩϡϝϯτͷؒҧ͍Λݟ͚ͭͨΒͲ͏͠
   ·͔͢ʁ
   1. ! εϧʔ
   2. " ؒҧ͍Λमਖ਼͢Δɺใࠂ͢Δ
   

   View Slide

5. OSSͷυΩϡϝϯτ΋ʮ࢓ࣄͰ࢖͏υ
   Ωϡϝϯτʯͱ͍͏͘͘ΓͰߟ͑Ε͹
   Ұॹ
   

   View Slide

6. ͨͱ͑͹ࣾ಺ͷυΩϡϝϯτͰؒҧ͍ݟ͚ͭͨΒ
   ؒ͜͜ҧ͑ͯ·͢Αʔɻͬͯ੠͔͚ͨΓɺαοͱमਖ਼ͨ͠Γ͠
   ·͢ΑͶ
   

   View Slide

7. ͠·͢ΑͶ…ʁ
   

   View Slide

8. ͦΕΛࣾ֎Ͱ΋΍Δ͚ͩ
   • ࣗ෼͕ͨͪ࢖͍ͬͯΔπʔϧʹࣾ಺΋ࣾ֎΋ͳ͍
   • ؒҧ͍Λ์ஔ͍ͯ͠Δͱ୭͔͕ϋϚΔ͔΋
   

   View Slide

9. ͔͠͠΍Γํ͕Θ͔Βͳ͍ͱϋʔυϧ
   ߴ͘ײͦ͡͏
   

   View Slide

10. આ໌͠·͢
    

    View Slide

11. (༨ஊ)࠷ۙͷ׆ಈใࠂͰ΋͋Δ
    ࠷ۙRubyॳ৺ऀ޲͚ͷຊΛࠪಡ͍ͯͯ͠ɺ֬ೝͷͨΊʹυΩϡ
    ϝϯτΛಡΈɺؒҧ͍Λݟ͚ͭͯPR΍IssueΛ࡞Δɺͱ͍͏͜ͱ
    ΛԿ౓͔΍ͬͯͨͷͰͦͷ׆ಈใࠂͰ΋͋Γ·͢
    

    View Slide

12. RubyͷυΩϡϝϯτ(೔ຊޠ)
    • ΦϒδΣΫτࢦ޲εΫϦϓτݴޠ Ruby ϦϑΝϨϯεϚχϡ
    Ξϧ
    • https://docs.ruby-lang.org/ja/latest/doc/index.html
    • ௨শΔΓ·
    • ࠷଎RubyϦϑΝϨϯεϚχϡΞϧݕࡧʂ | ΔΓ·αʔν
    • https://docs.ruby-lang.org/ja/search/
    

    View Slide

13. ೔ຊޠυΩϡϝϯτ͸GitHubͰ؅ཧ͞Ε͍ͯΔ
    • https://github.com/rurema/doctree
    

    View Slide

14. मਖ਼͚ͨ͠Ε͹Pull Request
    

    View Slide

15. ΔΓ·͸೔ຊޠͰPull
    Request΍Issueͩ͠
    ͯ΋େৎ෉ͦ͏
    

    View Slide

16. ฤू಺༰Λ֬ೝ͢Δํ๏
    • PRલʹɺฤू಺༰ΛHTMLʹͯ֬͠ೝ͢Δඞཁ͕͋Δ
    • markdown ͳͲमਖ਼ͯ͠΋ݟͨ໨Ͳ͏มΘΔͷ͔Θ͔Γ·
    ͤΜ
    • େ఍ͷ৔߹ɺͲ͔͜ʹ΍Γํ͕ॻ͍ͯ͋Δ(READMEͱ͔wiki
    ͱ͔)
    • ͳ͚Ε͹RakefileΛΈΔͱΑ͍
    

    View Slide

17. ΔΓ·ฤूͷ஫ҙ఺
    

    View Slide

18. ฤू಺༰Λ֬ೝ͢ΔͨΊͷ৘ใ͕ࢄΒ͹͍ͬͯͯ
    Θ͔Γʹ͍͘…
    • ͱΓ͋͑ͣ͜ͷ2͚͓͚֮ͭͩ͑ͯ͹ฤूɺ֬ೝͰ͖ͦ͏
    • bundle exec rake statichtml:2.5.0 Έ͍ͨʹ͢Δͱ /
    private/tmp/html ʹϑΝΠϧ͕ग़ྗ͞ΕΔ
    • /tmp/db-2.5.0 ͳͲʹதؒੜ੒෺ͷDB͕࡞੒͞ΕΔΑ͏
    ͳͷͰɺstatichtmlͰมߋ͕ͳ͍৔߹͸DBফͯ͠ϦτϥΠ
    ͢Δͱྑͦ͞͏
    

    View Slide

19. RubyͷυΩϡϝϯτ(ӳޠ)
    • Documentation for Ruby trunk
    • https://docs.ruby-lang.org/en/trunk/
    • Rubyຊମͷιʔείʔυ͔ΒRDocΛར༻ͯ͠ੜ੒
    

    View Slide

20. ӳޠυΩϡϝϯτ͸RDoc
    ͭ·ΓRubyຊମͷίϝϯτʹຒΊࠐ·Ε͍ͯΔ
    

    View Slide

21. मਖ਼͚ͨ͠Ε͹Pull Request
    • https://github.com/ruby/ruby
    • جຊతʹ͸redmineͷํ͕ྑ͍͚Ͳɺ؆୯ͳ಺༰ͳΒGitHub
    Ͱ΋Α͍͸ͣ…ʁ
    • ྫ: https://github.com/ruby/ruby/pull/1857
    

    View Slide

22. ೔ຊޠ൛ɺӳޠ൛υΩϡϝϯτΛϗεςΟϯά͠
    ͍ͯΔαʔόͷઃఆ΋GitHubͰ؅ཧ͞Ε͍ͯ·
    ͢
    • https://github.com/ruby/docs.ruby-lang.org
    

    View Slide

23. ϦϯΫ੾Εʹͳ͍ͬͯΔՕॴ
    Λݟ͚ͭͯɺαʔόཁҼͬΆ
    ͔ͬͨͷͰIssueΛ౤͛ͨਤ
    • https://github.com/ruby/docs.ruby-
    lang.org/issues/56
    

    View Slide

24. RailsͷެࣜυΩϡϝϯτ
    • http://api.rubyonrails.org/
    • (౰ͨΓલ͚ͩͲ)ӳޠ൛ͷΈ
    • https://github.com/rails/rails/
    • rdocͰੜ੒
    

    View Slide

25. RailsΨΠυ
    • http://guides.rubyonrails.org/
    • ຊମίʔυͱಉ͡ϦϙδτϦͰ؅ཧ͞Ε͍ͯΔ
    • https://github.com/rails/rails/tree/master/guides
    • markdownܗࣜ
    

    View Slide

26. मਖ਼͚ͨ͠Ε͹Pull Request
    • typoϨϕϧͳΒҰॠͰϚʔδ͞ΕΔ
    ͜ͱ͕ଟ͍
    • [ci skip]Λ๨Εͣʹ
    

    View Slide

27. RailsΨΠυ೔ຊޠ൛
    • ༗ࢤ(ओʹYassLabࣾ)͕ϝϯς͍ͯ͠Δ
    • ๻΋ίϛολʔͰ͢
    • ެࣜͱͷࠩ෼͔ͳΓ͋ΔͷͰPRνϟϯεͷๅݿ
    • https://github.com/yasslab/railsguides.jp
    

    View Slide

28. मਖ਼͚ͨ͠Ε͹Pull Request
    • ೔ຊޠͰPR࡞ΕΔͷͰෑډ͕௿͍
    • मਖ਼಺༰ͷ֬ೝํ๏΋READMEಡΊ
    ͹͙͢Ͱ͖·͢
    

    View Slide

29. (༨ஊ)ӳޠͰPR΍IssueΛॻ
    ͘ͱ͖ͷίπ
    • google຋༁ʹӳޠΛॻ͍ͯɺҙຯ͕
    ௨Δ͔֬ೝ
    • ͜Ε͚ͩͰ͍ͩͿ҆৺Ͱ͖Δ
    

    View Slide

30. ·ͱΊ
    • OSSͷυΩϡϝϯτ΋ɺࣾ಺ͷυΩϡϝϯτͱಉ͡Α͏ʹϝ
    ϯςφϯε͍͖ͯ͠·͠ΐ͏
    • ͍͍ͩͨGitHubͰPull RequestͰ͖·͢
    • ͓࡞๏͑͞཈͑Ε͹ɺ͋ͱ͸ࣾ಺ͷυΩϡϝϯτͱಉ͡Α͏
    ʹमਖ਼Ͱ͖·͢
    

    View Slide

31. (༨ஊ)mac࢖͍ͳΒDashΦεεϝͰ͢
    

    View Slide

32. ϩʔΧϧʹඞཁͳυΩ
    ϡϝϯτΛμ΢ϯϩʔ
    υ͓͍ͯͯ͠ɺαοͱ
    ݕࡧͰ͖·͢
    

    View Slide

33. $26.99 ͷՁ஋͸͋ΔΑ
    

    View Slide

34. happy documantating !
    

    View Slide