Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
ドキュメントを修正する
Search
Shinichi Maeshima
April 23, 2018
Technology
0
320
ドキュメントを修正する
株式会社リンカーズさんの社内勉強会で発表したLTのスライドです
Shinichi Maeshima
April 23, 2018
Tweet
Share
More Decks by Shinichi Maeshima
See All by Shinichi Maeshima
rails g authenticationから学ぶRails8.0時代の認証
willnet
5
3k
What's a well-behaved Rails extension gem?
willnet
0
420
Sidekiq vs Solid Queue
willnet
14
13k
どうしてこうなった?から理解するActive Recordの関連の裏側
willnet
6
1.5k
Exceptional Rails
willnet
6
7.8k
Breaking the Flaky Test Cycle
willnet
2
2.2k
mrskで広がるインフラの選択肢
willnet
1
1.1k
アプリケーションを長期にわたって無理なく運用するためのたったひとつの方法
willnet
2
2.2k
HotwireからDHHが考えるこれからのRailsとJSの付き合い方を知る
willnet
14
14k
Other Decks in Technology
See All in Technology
アイテムレビュー機能導入からの学びと改善
zozotech
PRO
0
180
能登半島地震において デジタルができたこと・できなかったこと
ditccsugii
0
250
能登半島災害現場エンジニアクロストーク 【JAWS FESTA 2025 in 金沢】
ditccsugii
0
890
衛星画像超解像化によって実現する2D, 3D空間情報の即時生成と“AI as a Service”/ Real-time generation spatial data enabled_by satellite image super-resolution
lehupa
0
170
Introduction to Sansan, inc / Sansan Global Development Center, Inc.
sansan33
PRO
0
2.8k
Node.js 2025: What's new and what's next
ruyadorno
0
400
Claude Code Subagents 再入門 ~cc-sddの実装で学んだこと~
gotalab555
10
16k
ガバメントクラウドの概要と自治体事例(名古屋市)
techniczna
3
240
プロダクトのコードから見るGoによるデザインパターンの実践 #go_night_talk
bengo4com
1
2.6k
Dylib Hijacking on macOS: Dead or Alive?
patrickwardle
0
220
スタートアップにおけるこれからの「データ整備」
shomaekawa
2
490
Git in Team
kawaguti
PRO
3
380
Featured
See All Featured
Bash Introduction
62gerente
615
210k
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
23
1.5k
A designer walks into a library…
pauljervisheath
209
24k
How To Stay Up To Date on Web Technology
chriscoyier
791
250k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
33
2.5k
Embracing the Ebb and Flow
colly
88
4.9k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
35
3.2k
Producing Creativity
orderedlist
PRO
347
40k
Connecting the Dots Between Site Speed, User Experience & Your Business [WebExpo 2025]
tammyeverts
10
600
Bootstrapping a Software Product
garrettdimon
PRO
307
110k
4 Signs Your Business is Dying
shpigford
185
22k
Music & Morning Musume
bryan
46
6.8k
Transcript
υΩϡϝϯτΛमਖ਼͢Δ @willnet
ීஈͷ։ൃɺͳΜΒ͔ͷυΩϡϝϯτ Λݟͳ͕Β։ൃ͠·͢ΑͶ
OSSͷυΩϡϝϯτͷؒҧ͍Λݟ͚ͭͨΒͲ͏͠ ·͔͢ʁ 1. εϧʔ 2. ؒҧ͍Λमਖ਼͢Δɺใࠂ͢Δ
OSSͷυΩϡϝϯτͷؒҧ͍Λݟ͚ͭͨΒͲ͏͠ ·͔͢ʁ 1. ! εϧʔ 2. " ؒҧ͍Λमਖ਼͢Δɺใࠂ͢Δ
OSSͷυΩϡϝϯτʮࣄͰ͏υ Ωϡϝϯτʯͱ͍͏͘͘ΓͰߟ͑Ε Ұॹ
ͨͱ͑ࣾͷυΩϡϝϯτͰؒҧ͍ݟ͚ͭͨΒ ؒ͜͜ҧ͑ͯ·͢Αʔɻ͔͚ͬͯͨΓɺαοͱमਖ਼ͨ͠Γ͠ ·͢ΑͶ
͠·͢ΑͶ…ʁ
ͦΕΛࣾ֎ͰΔ͚ͩ • ͕͍ࣗͨͪͬͯΔπʔϧʹࣾࣾ֎ͳ͍ • ؒҧ͍Λ์ஔ͍ͯ͠Δͱ୭͔͕ϋϚΔ͔
͔͠͠Γํ͕Θ͔Βͳ͍ͱϋʔυϧ ߴ͘ײͦ͡͏
આ໌͠·͢
(༨ஊ)࠷ۙͷ׆ಈใࠂͰ͋Δ ࠷ۙRubyॳ৺ऀ͚ͷຊΛࠪಡ͍ͯͯ͠ɺ֬ೝͷͨΊʹυΩϡ ϝϯτΛಡΈɺؒҧ͍Λݟ͚ͭͯPRIssueΛ࡞Δɺͱ͍͏͜ͱ ΛԿ͔ͬͯͨͷͰͦͷ׆ಈใࠂͰ͋Γ·͢
RubyͷυΩϡϝϯτ(ຊޠ) • ΦϒδΣΫτࢦεΫϦϓτݴޠ Ruby ϦϑΝϨϯεϚχϡ Ξϧ • https://docs.ruby-lang.org/ja/latest/doc/index.html • ௨শΔΓ·
• ࠷RubyϦϑΝϨϯεϚχϡΞϧݕࡧʂ | ΔΓ·αʔν • https://docs.ruby-lang.org/ja/search/
ຊޠυΩϡϝϯτGitHubͰཧ͞Ε͍ͯΔ • https://github.com/rurema/doctree
मਖ਼͚ͨ͠ΕPull Request
ΔΓ·ຊޠͰPull RequestIssueͩ͠ ͯେৎͦ͏
ฤू༰Λ֬ೝ͢Δํ๏ • PRલʹɺฤू༰ΛHTMLʹͯ֬͠ೝ͢Δඞཁ͕͋Δ • markdown ͳͲमਖ਼ͯ͠ݟͨͲ͏มΘΔͷ͔Θ͔Γ· ͤΜ • େͷ߹ɺͲ͔͜ʹΓํ͕ॻ͍ͯ͋Δ(READMEͱ͔wiki ͱ͔)
• ͳ͚ΕRakefileΛΈΔͱΑ͍
ΔΓ·ฤूͷҙ
ฤू༰Λ֬ೝ͢ΔͨΊͷใ͕ࢄΒ͍ͬͯͯ Θ͔Γʹ͍͘… • ͱΓ͋͑ͣ͜ͷ2͚͓͚֮ͭͩ͑ͯฤूɺ֬ೝͰ͖ͦ͏ • bundle exec rake statichtml:2.5.0 Έ͍ͨʹ͢Δͱ
/ private/tmp/html ʹϑΝΠϧ͕ग़ྗ͞ΕΔ • /tmp/db-2.5.0 ͳͲʹதؒੜͷDB͕࡞͞ΕΔΑ͏ ͳͷͰɺstatichtmlͰมߋ͕ͳ͍߹DBফͯ͠ϦτϥΠ ͢Δͱྑͦ͞͏
RubyͷυΩϡϝϯτ(ӳޠ) • Documentation for Ruby trunk • https://docs.ruby-lang.org/en/trunk/ • Rubyຊମͷιʔείʔυ͔ΒRDocΛར༻ͯ͠ੜ
ӳޠυΩϡϝϯτRDoc ͭ·ΓRubyຊମͷίϝϯτʹຒΊࠐ·Ε͍ͯΔ
मਖ਼͚ͨ͠ΕPull Request • https://github.com/ruby/ruby • جຊతʹredmineͷํ͕ྑ͍͚Ͳɺ؆୯ͳ༰ͳΒGitHub ͰΑ͍ͣ…ʁ • ྫ: https://github.com/ruby/ruby/pull/1857
ຊޠ൛ɺӳޠ൛υΩϡϝϯτΛϗεςΟϯά͠ ͍ͯΔαʔόͷઃఆGitHubͰཧ͞Ε͍ͯ· ͢ • https://github.com/ruby/docs.ruby-lang.org
ϦϯΫΕʹͳ͍ͬͯΔՕॴ Λݟ͚ͭͯɺαʔόཁҼͬΆ ͔ͬͨͷͰIssueΛ͛ͨਤ • https://github.com/ruby/docs.ruby- lang.org/issues/56
RailsͷެࣜυΩϡϝϯτ • http://api.rubyonrails.org/ • (ͨΓલ͚ͩͲ)ӳޠ൛ͷΈ • https://github.com/rails/rails/ • rdocͰੜ
RailsΨΠυ • http://guides.rubyonrails.org/ • ຊମίʔυͱಉ͡ϦϙδτϦͰཧ͞Ε͍ͯΔ • https://github.com/rails/rails/tree/master/guides • markdownܗࣜ
मਖ਼͚ͨ͠ΕPull Request • typoϨϕϧͳΒҰॠͰϚʔδ͞ΕΔ ͜ͱ͕ଟ͍ • [ci skip]ΛΕͣʹ
RailsΨΠυຊޠ൛ • ༗ࢤ(ओʹYassLabࣾ)͕ϝϯς͍ͯ͠Δ • ίϛολʔͰ͢ • ެࣜͱͷ͔ࠩͳΓ͋ΔͷͰPRνϟϯεͷๅݿ • https://github.com/yasslab/railsguides.jp
मਖ਼͚ͨ͠ΕPull Request • ຊޠͰPR࡞ΕΔͷͰෑډ͕͍ • मਖ਼༰ͷ֬ೝํ๏READMEಡΊ ͙͢Ͱ͖·͢
(༨ஊ)ӳޠͰPRIssueΛॻ ͘ͱ͖ͷίπ • google༁ʹӳޠΛॻ͍ͯɺҙຯ͕ ௨Δ͔֬ೝ • ͜Ε͚ͩͰ͍ͩͿ҆৺Ͱ͖Δ
·ͱΊ • OSSͷυΩϡϝϯτɺࣾͷυΩϡϝϯτͱಉ͡Α͏ʹϝ ϯςφϯε͍͖ͯ͠·͠ΐ͏ • ͍͍ͩͨGitHubͰPull RequestͰ͖·͢ • ͓࡞๏͑͑͞Εɺ͋ͱࣾͷυΩϡϝϯτͱಉ͡Α͏ ʹमਖ਼Ͱ͖·͢
(༨ஊ)mac͍ͳΒDashΦεεϝͰ͢
ϩʔΧϧʹඞཁͳυΩ ϡϝϯτΛμϯϩʔ υ͓͍ͯͯ͠ɺαοͱ ݕࡧͰ͖·͢
$26.99 ͷՁ͋ΔΑ
happy documantating !