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.3k
ドキュメンテーションを はじめよう
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
38
19k
メルカリ・メルカリShopsのCRE
naopr
0
550
3ヶ月で20万行を消すためにやったこと
naopr
17
16k
Technique to delete unused codes
naopr
0
1.6k
Other Decks in Business
See All in Business
Bridging the gap between your SEO strategy and success.
mrhfmn
0
170
新卒エンジニア向け dely会社説明資料 / New Grad Engineers
delyinc
0
350
Amazon 流のプロダクトマネジメント @ Product DeepLive 会場 + 懇親会スポンサーセッション
icoxfog417
3
290
リチェルカセキュリティ 会社紹介資料
ricsec
PRO
1
1.3k
ClipLine株式会社_会社紹介資料
clipline
0
410
株式会社gecogeco 会社紹介資料
gecogeco
2
2.1k
BrightonSEO 2023 - Focus on SEO won't make you an EEAT
chantalsminknl
0
110
【新卒採用】BuySell Technologies会社紹介資料
buyselltechnologies
0
170k
Timeless Principles: Google’s Constant Journey Through Past, Present, and Future
chapter42
0
310
TOKYOスマート・カルチャー・プロジェクト
tokyo_metropolitan_gov_digital_hr
0
280
エンジニアの「センス」とは何か / What is the sense of engineers
hiro_y
19
6.5k
enechain company deck
enechain
PRO
7
88k
Featured
See All Featured
The Power of CSS Pseudo Elements
geoffreycrofte
71
5.3k
Gamification - CAS2011
davidbonilla
80
5k
Statistics for Hackers
jakevdp
796
220k
Pencils Down: Stop Designing & Start Developing
hursman
119
11k
The Cost Of JavaScript in 2023
addyosmani
43
5.9k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
504
140k
Bootstrapping a Software Product
garrettdimon
PRO
305
110k
Imperfection Machines: The Place of Print at Facebook
scottboms
264
13k
Facilitating Awesome Meetings
lara
49
6k
What's in a price? How to price your products and services
michaelherold
243
11k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
26
1.4k
The Art of Delivering Value - GDevCon NA Keynote
reverentgeek
5
130
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ਓͰݶք͕͋Δ ◦ ఆظతʹษڧձ͕Ͱ͖ͨΒཧ ·͔ͣ͜͜Β
ࠓͷൃද͕օ͞ΜͷΞΫγϣϯʹͭͳ͕Δ͜ͱΛف͍ͬͯ·͢ υΩϡϝϯτจԽ Ұʹͯ͠Βͣ