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
HikaruMaruyama
May 19, 2017
Programming
5
2k
人の役に立ちたい一心でドキュメントを改善してみたら思っていた以上に効果が出た話
HikaruMaruyama
May 19, 2017
Tweet
Share
More Decks by HikaruMaruyama
See All by HikaruMaruyama
OSS CMS「Drupal 10」 エッセンシャル:最新版でのWeb開発の魅力を探る #oscnagoya
hmaruyama
0
230
スタイリッシュでモダンな「Gin」管理テーマの紹介 #drupal_haneda
hmaruyama
0
170
DrupalのWeb Profiler #drupal_haneda
hmaruyama
0
280
非エンジニアから開発者まで!DrupalPodを使用したDrupal環境の作成
hmaruyama
1
280
Drupal認定試験にチャレンジしよう!アクイア認定プログラムのご紹介 / introduction of Acquia Drupal Certification Program
hmaruyama
0
890
「Docker/Kubernetes実践コンテナ開発入門」学習のポイント #dockerbg / 20191108
hmaruyama
0
110
enebularでobnizを Lチカ してみた #enebular / 20181122
hmaruyama
0
530
駅すぱあとWebサービス連携ハンズオンパート ノンプログラミングでClovaスキルハンズオン&お茶会 #linebootawards #Clova_CEK / 20180919
hmaruyama
1
570
Agent Friends Xperia Ear Duoで誰でも コミュニケーションにコミット #linebootawards / 20180826
hmaruyama
0
88
Other Decks in Programming
See All in Programming
Monixと常駐プログラムの勘どころ / Scalaわいわい勉強会 #4
stoneream
0
340
テストケースの名前はどうつけるべきか?
orgachem
PRO
1
290
Fibonacci Function Gallery - Part 1
philipschwarz
PRO
0
270
Amazon Nova Reelの可能性
hideg
0
140
KMP와 kotlinx.rpc로 서버와 클라이언트 동기화
kwakeuijin
0
280
Jaspr Dart Web Framework 박제창 @Devfest 2024
itsmedreamwalker
0
140
PHPで学ぶプログラミングの教訓 / Lessons in Programming Learned through PHP
nrslib
4
1k
rails newと同時に型を書く
aki19035vc
5
680
今年のアップデートで振り返るCDKセキュリティのシフトレフト/2024-cdk-security-shift-left
tomoki10
0
350
歴史と現在から考えるスケーラブルなソフトウェア開発のプラクティス
i10416
0
290
DevFest - Serverless 101 with Google Cloud Functions
tunmise
0
130
Beyond ORM
77web
11
1.5k
Featured
See All Featured
Building an army of robots
kneath
302
44k
What’s in a name? Adding method to the madness
productmarketing
PRO
22
3.2k
Side Projects
sachag
452
42k
GitHub's CSS Performance
jonrohan
1030
460k
We Have a Design System, Now What?
morganepeng
51
7.3k
Bash Introduction
62gerente
610
210k
Docker and Python
trallard
43
3.2k
Fashionably flexible responsive web design (full day workshop)
malarkey
406
66k
Creating an realtime collaboration tool: Agile Flush - .NET Oxford
marcduiker
26
1.9k
Fantastic passwords and where to find them - at NoRuKo
philnash
50
2.9k
A Modern Web Designer's Workflow
chriscoyier
693
190k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
33
2.7k
Transcript
ਓͷʹཱ͍ͪͨҰ৺Ͱ υΩϡϝϯτΛվળͯ͠ΈͨΒ ࢥ͍ͬͯͨҎ্ʹޮՌ͕ग़ͨ API Meetup Fukuoka ؙࢁ ͻ͔Δ
None
None
ࣗݾհ • גࣜձࣾϰΝϧݚڀॴ • ؙࢁ ͻ͔Δ • ςΫχΧϧΤόϯδΣϦετ • ਆಸݝ૬ݪࢢࡏॅ
ܦྺ 20144݄ 20147݄ 20157݄ 2017݄1݄ ϰΝϧݚڀॴ ೖࣾ WebAPIʮӺ͢ͺ͋ͱwebαʔϏεʯ ։ൃϝϯόʔʹ ৽ػೳ։ൃอकɺج൫ͷվम
υΩϡϝϯτվળνʔϜͷҰһʹ ձࣾॳ ςΫχΧϧΤόϯδΣετʹ
2014
None
WebAPIͷ෦ॺʹଐ • ૣ͘νʔϜʹೃછΈ͍ͨ • Կ͔Βͳ͍ɺ͕ࣝͳ͍
ͦ͏ͩɺLTΛ͠Α͏
ࣾLTͷࢀՃ • αʔϏεͷࣝΛਂΊΔͨΊʹ • Πϯϓοτ͢ΔʹΞτϓοτ͕Ұ൪ • ࣦഊ͢ΔͳΒࠓ͔͠ͳ͍ • ࣾͰ݄ʹ̍ճߦΘΕΔLTʹ 5ճ࿈ଓͰࢀՃ͢Δ͜ͱΛܾҙ
LT༰ͷࡧ ʮͦ͏͍͑͏ͪͷυΩϡϝϯτɺ ٯҾ͖ϦϑΝϨϯεతͳͷͬͯͳ͍ΜͰ͢Ͷɻ ྫ͑ɺ͋Δܦ࿏Λఆظ݊Λར༻ͯͬͨ͠ͱ͖ͷ ӡܭࢉ͕͍ͨ࣌͠ʹɺAPIͷ༷͔Β ࣗͰ୳͞ͳ͍ͱ͍͚ͳ͍ΜͰ͢Ͷɻʯ ʮ͔֬ʹݴΘΕͯΈΕͦ͏ͩͶɻ͏ͪͷWebAPIͬͯ ͍ํ͕ෳࡶ͔ͩΒɺ͋ΔͱศརͩͶɻʯ
ͦΕͩʂ
• ࣾһͷԠ • ؒతͳϑΟʔυόοΫ • ࣾͰ Ӻ͢ͺ͋ͱWebαʔϏεʹ ؙࢁʁ • WebAPIͷֶͼ
• ײతͰͳ্͍ʹ υΩϡϝϯτ؆ૉ • Ӻ͢ͺ͋ͱWebαʔϏεʹ Θ͔ΓͮΒ͍WebAPI
2015
;ͱͨ͠ձ͔Β ʮSSLରԠ͔ͨ͠ΒυΩϡϝϯταΠτʹࡌ͓͍ͤͯͯʔʯ ʮͲ͜ʹࡌͤΔΜͰ͔͢ɻࠓAPIͷ༷͔͠ࡌͤͯͳ͍͔Βɺࡌͤ Δͱͨ͠Β৽͘͠ίϯςϯπΛ࡞Δඞཁ͕͋ΔΜ͡Όͳ͍Ͱ͔͢ʁʯ ʮ͔֬ʹಋೖ෦ͷ͍߹Θͤଟ͍͠ʲελʔτΞοϓΨΠυʳͱ ͔ཉ͍͠Ͷ͑ʯ ʮSSLରԠͷ݅ʲΑ͋͘Δ͓͍߹ΘͤʳͰٵऩͰ͖ͦ͏Ͱ͢ Ͷʂʯ ʮίϯςϯπΛ૿͢ͳΒɺӦۀͱαϙʔτʹ૬ஊͯ͠ΈͨΒʁ Ϣʔβͷ૭ޱʹͳͬͯΔ͔Βʯ
ͦΕͩʂ(2ճ)
υΩϡϝϯτվળʹ औΓΉ͜ͱʹ
υΩϡϝϯτվળνʔϜ݁ • ݁ͷܦҢ • Ӧۀ෦ॺͷਓʹ૬ஊͨ͠ΒɺʮੋඇΓ͍ͨʂʯͱݴ͏ਓΛ հͯ͘͠Εͨ • Ӧۀ෦ॺͷਓ͕αϙʔτ෦ॺͷਓΛݺΜͰ͘Εͨ • νʔϜฤ
• Ӻ͢ͺ͋ͱwebαʔϏεͷӦۀΛ୲͢Δ෦ॺɹɹɿ1ਓ • Ӻ͢ͺ͋ͱwebαʔϏεͷαϙʔτΛ୲͢Δ෦ॺɿ1ਓ • Ӻ͢ͺ͋ͱwebαʔϏεͷ։ൃΛ୲͢Δ෦ॺɹɹɿ1ਓ • ӡ༻ • ݄1ճͷఆྫMTG • త • Ӻ͢ͺ͋ͱwebαʔϏεͷՁ্
ԿΛվળ͢Δʁ
࠷ͳWebAPIυΩϡϝϯτ
• ι͔ͬΓ • ߋ৽͞Εͳ͍ • ߋ৽ཤྺ͕ͳ͍ • ઐ༻ޠͷઆ໌ͳ͠ • ౷Ұੑ͕ͳ͍
• ٯҾ͖͕ͳ͍ • ཉ͍͠ใ͕ݟ͔ͭΒͳ͍ • ԿΛͬͨΒ͓͔͔ۚΔ͔͔Βͳ͍ • ԿΛ͑Δͷ͔͔Βͳ͍ • ϑϦʔϓϥϯ/ελϯμʔυϓϥϯͷυΩϡϝϯταΠτ͕ࠅࣅ͍ͯͯ͠ ۠ผ͠ʹ͍͘ ࠷ͳWebAPIυΩϡϝϯτ
ඇΤϯδχΞͱҰॹʹ GithubͰཧ • όʔδϣϯཧ͞Ε͍ͯͳ͔ͬͨυΩϡϝϯτͷιʔείʔυΛ GithubཧԼʹ • υΩϡϝϯτվળνʔϜʹGithubͰϓϧϦΫΛ֬ೝͯ͠΄͍͠ͱએݴ • ͢ΜͳΓOK͞ΕɺΞΧϯτΛऔಘͯ͠Β͏ •
ஸೡͳϨΫνϟʔ • ϓϧϦΫͷ֬ೝํ๏ • ίϝϯτͷํ • ઈରʹԡͪ͠Ό͍͚ͳ͍Ϙλϯ (mergeϘλϯ)
ςεταΠτͷ༻ҙ • ඇΤϯδχΞ͕GithubͰϓϧϦΫΛ ֬ೝͯ͠Β͍͘͢͢ΔͨΊ • ιʔείʔυ͚ͩͩͱɺϨΠΞτ͕བྷΉ ϓϧϦΫΛ֬ೝ͢Δ͜ͱ͕Ͱ͖ͳ͍ • AWS S3ʹςεταΠτ༻ͷBucketΛ༻ҙ͠ɺ
࡞ۀϒϥϯνͷ༰Λөͤͨ͞
ࣗಈσϓϩΠ • ϓϧϦΫ͕Ϛʔδ͞ΕΔͨͼʹɺຖճAWS S3ʹ खಈͰϑΝΠϧΛΞοϓϩʔυ͢Δͷ ໘͍҆͘͞͠શ͡Όͳ͍ • Wercker(CIπʔϧ)Λͬͯ σϓϩΠࣗಈԽͷઃఆΛߦ͏ •
࡞ۀ͕அવָʹ
੩తαΠτδΣωϨʔλಋೖ • ͕ੵΈ্͕͍ͬͯͨ • googleΞφϦςΟΫεΞϯέʔτϑΥʔϜΛҰ෦ͷ ϖʔδʹ͔͠औΓೖΕΒΕͳ͍ • ૉͷhtmlΛվม͠ଓ͚Δ͜ͱ݈શͰͳ͍ • υΩϡϝϯτmarkdownͰཧ͍ͨ͠
• middlemanಋೖ • html͔ΒmarkdownͷมखͰߦͬͨ(ল)
վળͷޮՌ
։ൃαϙʔτۀͷܰݮ • νέοτͷਪҠ • 39ظ(վળલ)ͷ߹ܭɿ178 • 40ظ(վળޙ)ͷ߹ܭɿ141 → 20%ݮ
Ϣʔβͷฦ৴͕εϜʔζʹ
Ϣʔβ͔ΒϑΟʔυόοΫ • υΩϡϝϯτ͕Θ͔Γ͍͢͜ͱͰɺϢʔβͷ ։ൃίετ͕ܰݮ • ಋೖࣄྫͰυΩϡϝϯτ͕๙ΊΒΕΔΑ͏ʹ
ͬͨͥʂ
υΩϡϝϯτվળͯ͠Έͯ • Ϣʔβ͔ΒͷϑΟʔυόοΫ͕Ϟνϕʔγϣϯʹ • αϙʔτରԠ࣌ؒΛଞͷ͜ͱʹ͑Δ • औΓΉதͰ͕ࣝ૿͑ͨ
ͦΕҎ֎ʹ • υΩϡϝϯτ͕ྑ͘ͳ͚ͬͨͩͰͳ͘ • νʔϜͷதͰɺࢲҎ֎ʹυΩϡϝϯτͷ ϓϧϦΫΛࣗओతʹग़ͯ͘͠ΕΔ • ։ൃҎ֎ͷਓͱू·Δ͕࣌ؒ૿͑ɺ ใڞ༗ͷͱͳͬͨ
ৼΓฦͬͯΈΔͱ
Կ͔Βͳ͔ͬͨ࣌ • Ͱ͖ͦ͏ͳ͜ͱ͔ΒͬͯΈͨ • ࣾLT • ࣝͷٵऩ • ࣾһͱͷձ͕ੜ·ΕΔ •
υΩϡϝϯτվળʹͭͳ͕ͬͨ • …etc
Thank you!
͓ؼΓͷࡍ Ӻ͢ͺ͋ͱΞϓϦͰ