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
Naoto Sato
May 29, 2024
Business
6
1.5k
ドキュメンテーションを はじめよう
2024/05/29に開催された Designing Documentation Culture #1 - Notionと学ぶ、ドキュメント文化 でLTした資料です。
Naoto Sato
May 29, 2024
Tweet
Share
More Decks by Naoto Sato
See All by Naoto Sato
「推測するな、計測せよ」 〜小さく始める生産性可視化と分析〜
naopr
44
21k
メルカリ・メルカリShopsのCRE
naopr
0
650
3ヶ月で20万行を消すためにやったこと
naopr
17
16k
Technique to delete unused codes
naopr
0
1.7k
Other Decks in Business
See All in Business
自分の未来を創る第一歩 サクセッションプランニングと省察でたちカエル
sai_kaneko
1
370
Paris 2024 ~パリ・パラリンピック プチ紀行~:2720 Japan O.K. ロータリーEクラブ・AITO 代表 紅葉谷 昌代 会員
2720japanoke
0
630
Crisp Code コーポレート・サービス紹介 | Corporate & Services Introduction
so_kotani
0
180
モノリシックな「Chatwork」から、認証基盤をどのように切り出していったか
kubell_hr
1
260
【新卒採用】BuySell Technologies会社紹介資料
buyselltechnologies
0
210k
新しいAI体験を生み出すための v0プロトタイプ駆動型開発
inagakikay
0
1k
株式会社メディアドゥ 中期経営計画 2026-2030年2月期(5ヵ年)
mediado_ir
0
180
Local SEO for real people: 20 hard-hitting (and hilarious) audit lessons
ehababoud
0
270
Crisp Code inc. | わたしたちの事例/実績 - Portfolio
so_kotani
1
980
メドピアグループ紹介資料
medpeer_recruit
10
130k
会社紹介資料【ギバーテイクオール株式会社】
givertakeall
0
2.1k
株式会社ジュニ - 採用ピッチ
junni_inc
1
17k
Featured
See All Featured
The Straight Up "How To Draw Better" Workshop
denniskardys
232
140k
XXLCSS - How to scale CSS and keep your sanity
sugarenia
248
1.3M
Stop Working from a Prison Cell
hatefulcrawdad
268
20k
Evolution of real-time – Irina Nazarova, EuRuKo, 2024
irinanazarova
8
670
jQuery: Nuts, Bolts and Bling
dougneiner
63
7.7k
The Invisible Side of Design
smashingmag
299
50k
Into the Great Unknown - MozCon
thekraken
37
1.7k
Intergalactic Javascript Robots from Outer Space
tanoku
270
27k
Put a Button on it: Removing Barriers to Going Fast.
kastner
60
3.8k
Building Applications with DynamoDB
mza
94
6.3k
Optimising Largest Contentful Paint
csswizardry
36
3.2k
Gamification - CAS2011
davidbonilla
81
5.2k
Transcript
υΩϡϝϯςʔγϣϯΛ ͡ΊΑ͏ 2024/05/29 Designing Documentation Culture #1 @naopr
• @naopr (ͳ͓ͺʔ) • Engineering Manager/Design Manager @mybest • Love
🐈 㽪 🍺 🍶 🛫 ࣗݾհ
Θͨ͠ͱυΩϡϝϯτʢݸਓʣ
Θͨ͠ͱυΩϡϝϯτʢձࣾʣ DeNA (500ਓˠ2000ਓ) 2011 ϝϧΧϦ (500ਓˠ2000ਓ) 201 7 ϚΠϕετ (200ਓ)
2023 ήʔϜͷֆίϯςͱ༷ॻ ݸਓɾ෦ॺ୯Ґͷۀใ ٞࣄ ݸਓɾ෦ॺ୯Ґͷۀใɺٞࣄ
• ʑॏཁ্͕͕͍ͬͯΔ ◦ ϦϞʔτϫʔΫ ◦ ඇಉظίϛϡχέʔγϣϯ • ͲͷձࣾΈ͕͋Δ ◦ πʔϧબఆ
◦ υΩϡϝϯςʔγϣϯจԽͷৢ ◦ ӡ༻ϧʔϧͷ࡞ɾపఈ • ۜͷؙͳ͍ υΩϡϝϯςʔγϣϯʹ͍ͭͯࢥ͏͜ͱ
͔͜͜Β͕ຊ ΑΓΑ͍υΩϡϝϯςʔγϣϯจԽΛ࡞ΔͨΊͷ جຊతͳϓϥΫςΟεΛհ͠·͢
ۜͷؙͳ͍ʂͰϕετϓϥΫςΟε͋Δ GitLab • ΞϓϦέʔγϣϯ։ൃࢧԉπʔϧΛఏڙ͢Δձࣾ • ੈք࠷େɾ࠷ઌͷϦϞʔτ৫ ◦ ੈք67ΧࠃҎ্ɺࣾһ2000໊Ҏ্ ◦ ΦϑΟεΛ࣋ͨͳ͍
• ৫ͷϧʔϧΛʮGitLab Handbookʯʹू ◦ 3000ϖʔδ ◦ Web্ʹެ։͞Ε͓ͯΓ୭ͰӾཡՄೳ GitLabʹֶͿ ੈք࠷ઌͷϦϞʔτ৫ͷͭ͘Γ͔ͨ - https://www.shoeisha.co.jp/book/detail/9784798183916
1. ʮ͔͢ΕͨΠϯΫ໌ͳهԱʹউΔʯ 2. ϛʔςΟϯάඞͣٞࣄΛ͢ 3. σϑΥϧτެ։ઃఆ 4. SSoT(Single Source of
Truth) - ৴པͰ͖Δ།Ұͷใݯ GitLabʹֶͿϕετϓϥΫςΟε
• ใͷਖ਼֬͞ɿਓؒͷهԱ <<< ه • ୡͷ༰қ͞ɾޮ ◦ ˕ هɿࣗͰݕࡧͰ͖ΔɺϦϯΫΛڞ༗͢Δ͚ͩ ◦
✕ هԱɿຊਓʹ࣭͢Δඞཁ͕͋Δ 1. ʮ͔͢ΕͨΠϯΫ໌ͳهԱʹউΔʯ ϑΥʔϚοτݴ͍ճ͠Λؾʹͤͣ·ͣॻ͘͜ͱ͕େࣄ
• ຊͷதͰʮٞࣄʯ11ճొ͍ͯ͠Δ͘Β͍ॏཁ • ϝϦοτ͕ଟ͍ ◦ ࢀՃͯ͠ͳ͍ਓͰ༰͕֬ೝͰ͖Δ ◦ ೝࣝͷෆҰக͕ى͜Γʹ͍͘ ◦ ҙࢥܾఆͷಁ໌ੑ͕୲อ͞ΕΔ
• ϛʔςΟϯάલͷ४උ͕େࣄ ◦ ٞࣄʹΞδΣϯμΛॻ͘ ◦ ΧϨϯμʔʹٞࣄΛఴ͢Δ 2. ϛʔςΟϯάඞͣٞࣄΛ͢ ͜ΕΒΛపఈ͢Δ
ྫʣϚΠϕετͷٞࣄϑΥʔϚοτ
• GitLabͷόϦϡʔͷ1ͭʹʮಁ໌ੑʯ͕͋Δ ◦ ίϥϘϨʔγϣϯͷଅਐ ◦ ৫ͷ݈શੑҡ࣋ • ެ։͍͚ͯ͠ͳ͍ͷΛఆٛ͢ΔSAFEϑϨʔϜϫʔΫ ◦ Sensitive
- ηϯγςΟϒ ◦ Accurate - ਖ਼֬ͳใ ◦ Financial - ࡒใ ◦ Effect - Өڹ 3. σϑΥϧτެ։ઃఆ ެ։NGͳͷҎ֎શͯެ։
• ࠷৽ͷਖ਼֬ͳใ͕1ϲॴʹ͔͠ଘࡏ͠ͳ͍͜ͱ ◦ ࠷৽ɿ࢛ظʹҰͳͲఆظతʹݟͯ͠ߋ৽͢Δ ◦ ਖ਼֬ɿޡΓΛݟ͚ͭͨΒ୭Ͱߋ৽Ͱ͖Δ ◦ 1ϲॴɿ ▪ πʔϧΛ౷Ұ͢Δ
▪ Ͳ͜ʹͲΜͳใΛॻ͔͘ϧʔϧΛܾΊΔ 4. SSoT(Single Source of Truth) ~৴པͰ͖Δ།Ұͷใݯ~
1. ʮ͔͢ΕͨΠϯΫ໌ͳهԱʹউΔʯ 2. ϛʔςΟϯάඞͣٞࣄΛ͢ 3. σϑΥϧτެ։ઃఆ 4. SSoT(Single Source of
Truth) - ৴པͰ͖Δ།Ұͷใݯ ʢ࠶ܝʣGitLabʹֶͿϕετϓϥΫςΟε
• ϛʔςΟϯάͷٞࣄΛશͯͯ͠ΈΔ ◦ ςϯϓϨʔτΛ࡞Δ • ݸਓϝϞͰػೳΛࢼͯ͠ΈΔ ◦ ࣦഊͯ͠୭ʹ໎͕͔͔Βͳ͍ ◦ ϊϋΛஷΊͯࣗࣾͷ׆༻ΠϝʔδΛ͚ͭΔ
• ؒΛ୳ͯ͠ҰॹʹਐΊΔ ◦ 1ਓͰݶք͕͋Δ ◦ ఆظతʹษڧձ͕Ͱ͖ͨΒཧ ·͔ͣ͜͜Β
ࠓͷൃද͕օ͞ΜͷΞΫγϣϯʹͭͳ͕Δ͜ͱΛف͍ͬͯ·͢ υΩϡϝϯτจԽ Ұʹͯ͠Βͣ