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
Sponsored
·
Your Podcast. Everywhere. Effortlessly.
Share. Educate. Inspire. Entertain. You do you. We'll handle the rest.
→
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
280
スタイリッシュでモダンな「Gin」管理テーマの紹介 #drupal_haneda
hmaruyama
0
260
DrupalのWeb Profiler #drupal_haneda
hmaruyama
0
350
非エンジニアから開発者まで!DrupalPodを使用したDrupal環境の作成
hmaruyama
1
350
Drupal認定試験にチャレンジしよう!アクイア認定プログラムのご紹介 / introduction of Acquia Drupal Certification Program
hmaruyama
0
1k
「Docker/Kubernetes実践コンテナ開発入門」学習のポイント #dockerbg / 20191108
hmaruyama
0
160
enebularでobnizを Lチカ してみた #enebular / 20181122
hmaruyama
0
590
駅すぱあとWebサービス連携ハンズオンパート ノンプログラミングでClovaスキルハンズオン&お茶会 #linebootawards #Clova_CEK / 20180919
hmaruyama
1
650
Agent Friends Xperia Ear Duoで誰でも コミュニケーションにコミット #linebootawards / 20180826
hmaruyama
0
140
Other Decks in Programming
See All in Programming
CSC307 Lecture 06
javiergs
PRO
0
690
CSC307 Lecture 04
javiergs
PRO
0
660
MUSUBIXとは
nahisaho
0
140
Oxlint JS plugins
kazupon
1
1k
CSC307 Lecture 08
javiergs
PRO
0
670
Lambda のコードストレージ容量に気をつけましょう
tattwan718
0
150
The Past, Present, and Future of Enterprise Java
ivargrimstad
0
620
生成AIを使ったコードレビューで定性的に品質カバー
chiilog
1
280
それ、本当に安全? ファイルアップロードで見落としがちなセキュリティリスクと対策
penpeen
7
4k
Fluid Templating in TYPO3 14
s2b
0
130
Amazon Bedrockを活用したRAGの品質管理パイプライン構築
tosuri13
5
800
今から始めるClaude Code超入門
448jp
8
9.1k
Featured
See All Featured
Ten Tips & Tricks for a 🌱 transition
stuffmc
0
72
Heart Work Chapter 1 - Part 1
lfama
PRO
5
35k
Future Trends and Review - Lecture 12 - Web Technologies (1019888BNR)
signer
PRO
0
3.2k
Unsuck your backbone
ammeep
671
58k
Optimising Largest Contentful Paint
csswizardry
37
3.6k
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
eileencodes
26
3.3k
Building a Scalable Design System with Sketch
lauravandoore
463
34k
The #1 spot is gone: here's how to win anyway
tamaranovitovic
2
950
Agile that works and the tools we love
rasmusluckow
331
21k
Keith and Marios Guide to Fast Websites
keithpitt
413
23k
Rebuilding a faster, lazier Slack
samanthasiow
85
9.4k
Why Our Code Smells
bkeepers
PRO
340
58k
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!
͓ؼΓͷࡍ Ӻ͢ͺ͋ͱΞϓϦͰ