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
1.9k
人の役に立ちたい一心でドキュメントを改善してみたら思っていた以上に効果が出た話
HikaruMaruyama
May 19, 2017
Tweet
Share
More Decks by HikaruMaruyama
See All by HikaruMaruyama
OSS CMS「Drupal 10」 エッセンシャル:最新版でのWeb開発の魅力を探る #oscnagoya
hmaruyama
0
210
スタイリッシュでモダンな「Gin」管理テーマの紹介 #drupal_haneda
hmaruyama
0
160
DrupalのWeb Profiler #drupal_haneda
hmaruyama
0
260
非エンジニアから開発者まで!DrupalPodを使用したDrupal環境の作成
hmaruyama
1
260
Drupal認定試験にチャレンジしよう!アクイア認定プログラムのご紹介 / introduction of Acquia Drupal Certification Program
hmaruyama
0
840
「Docker/Kubernetes実践コンテナ開発入門」学習のポイント #dockerbg / 20191108
hmaruyama
0
95
enebularでobnizを Lチカ してみた #enebular / 20181122
hmaruyama
0
510
駅すぱあとWebサービス連携ハンズオンパート ノンプログラミングでClovaスキルハンズオン&お茶会 #linebootawards #Clova_CEK / 20180919
hmaruyama
1
550
Agent Friends Xperia Ear Duoで誰でも コミュニケーションにコミット #linebootawards / 20180826
hmaruyama
0
84
Other Decks in Programming
See All in Programming
UnJSで簡単に始めるCLIツール開発 / cli-tool-development-with-unjs
aoseyuu
2
380
App Store Connect APIで 作業時間を増やそう
mot_techtalk
3
140
/←このスケジュール表に立ち向かう フロントエンド開発戦略 / A front-end development strategy to tackle a single-slash schedule.
nrslib
1
430
(Deep|Web) Link support with expo-router
mrtry
0
190
現場から考えるソフトウェアエンジニアリングの価値と実験
nomuson
1
140
フロントエンドの現在地とこれから
koba04
10
4.7k
Vitest Browser Mode への期待 / Vitest Browser Mode
odanado
PRO
1
1.2k
自分だけの世界を創るクリエイティブコーディング / Creative Coding: Creating Your Own World
chobishiba
2
2.1k
ActiveRecordの力でDBのメタデータを迅速に解析する
lnit
5
2k
Vertical Architectures for Scalable Angular Applications
manfredsteyer
PRO
0
210
今日で分かる!カスタムコップの作り方
krpk1900
2
270
Scan with Decoupled Look-back and Onesweep Radix Sort
shocker_0x15
0
150
Featured
See All Featured
Done Done
chrislema
181
16k
What's in a price? How to price your products and services
michaelherold
243
11k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
126
18k
CoffeeScript is Beautiful & I Never Want to Write Plain JavaScript Again
sstephenson
159
15k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
364
22k
Designing Dashboards & Data Visualisations in Web Apps
destraynor
228
52k
Building Better People: How to give real-time feedback that sticks.
wjessup
363
19k
Scaling GitHub
holman
458
140k
Bootstrapping a Software Product
garrettdimon
PRO
305
110k
BBQ
matthewcrist
85
9.2k
How to Think Like a Performance Engineer
csswizardry
18
1k
Optimising Largest Contentful Paint
csswizardry
31
2.9k
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!
͓ؼΓͷࡍ Ӻ͢ͺ͋ͱΞϓϦͰ