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
290
ドキュメントを修正する
株式会社リンカーズさんの社内勉強会で発表したLTのスライドです
Shinichi Maeshima
April 23, 2018
Tweet
Share
More Decks by Shinichi Maeshima
See All by Shinichi Maeshima
Sidekiq vs Solid Queue
willnet
14
11k
どうしてこうなった?から理解するActive Recordの関連の裏側
willnet
6
1.4k
Exceptional Rails
willnet
6
7.2k
Breaking the Flaky Test Cycle
willnet
2
2k
mrskで広がるインフラの選択肢
willnet
1
1k
アプリケーションを長期にわたって無理なく運用するためのたったひとつの方法
willnet
2
2.1k
HotwireからDHHが考えるこれからのRailsとJSの付き合い方を知る
willnet
14
13k
Rails6.1で新しく入る機能について
willnet
12
15k
Concerns about Concerns
willnet
11
34k
Other Decks in Technology
See All in Technology
依存パッケージの更新はコツコツが勝つコツ! / phpcon_nagoya2025
blue_goheimochi
3
200
Classmethod AI Talks(CATs) #17 司会進行スライド(2025.02.19) / classmethod-ai-talks-aka-cats_moderator-slides_vol17_2025-02-19
shinyaa31
0
170
EDRの検知の仕組みと検知回避について
chayakonanaika
8
4.2k
Raycast Favorites × Script Command で実現するお手軽情報チェック
smasato
1
120
ディスプレイ広告(Yahoo!広告・LINE広告)におけるバックエンド開発
lycorptech_jp
PRO
0
200
エンジニアが加速させるプロダクトディスカバリー 〜最速で価値ある機能を見つける方法〜 / product discovery accelerated by engineers
rince
4
520
Reading Code Is Harder Than Writing It
trishagee
2
120
php-conference-nagoya-2025
fuwasegu
0
130
一度 Expo の採用を断念したけど、 再度 Expo の導入を検討している話
ichiki1023
1
250
Two Blades, One Journey: Engineering While Managing
ohbarye
3
700
OpenID BizDay#17 KYC WG活動報告(法人) / 20250219-BizDay17-KYC-legalidentity
oidfj
0
450
ホワイトボードチャレンジ 説明&実行資料
ichimichi
0
140
Featured
See All Featured
Designing on Purpose - Digital PM Summit 2013
jponch
117
7.1k
The MySQL Ecosystem @ GitHub 2015
samlambert
250
12k
Music & Morning Musume
bryan
46
6.4k
Gamification - CAS2011
davidbonilla
80
5.1k
Fireside Chat
paigeccino
34
3.2k
What's in a price? How to price your products and services
michaelherold
244
12k
The Cult of Friendly URLs
andyhume
78
6.2k
How To Stay Up To Date on Web Technology
chriscoyier
790
250k
Unsuck your backbone
ammeep
669
57k
Reflections from 52 weeks, 52 projects
jeffersonlam
348
20k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
27
1.6k
Done Done
chrislema
182
16k
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 !