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
18k
メルカリ・メルカリShopsのCRE
naopr
0
540
3ヶ月で20万行を消すためにやったこと
naopr
17
16k
Technique to delete unused codes
naopr
0
1.6k
Other Decks in Business
See All in Business
株式会社イードア会社説明資料
sredoa
1
300
hokan Recruiting Deck
hokan
0
20k
エキサイトホールディングス株式会社 - 会社説明 -
excitejp
PRO
0
960
株式会社CloudSoft 会社説明資料
csmatsushita
0
190
Mercari-Fact-book_en
mercari_inc
1
21k
20240914_CMCKochi_6
hideki_ojima
1
210
ネオキャリア新卒採用サイト_会社説明スライド
neo_recruit
1
72k
SQUEEZE会社紹介資料 / we-are-hiring
shin1
0
25k
LP会社資料
lifepartnersinc
0
120
UNICORN FOR Apple Search Ads 紹介資料
unicorn
0
230
株式会社CyberOwl_エンジニア向け会社紹介資料
cyberowl
0
320
株式会社Rehab for JAPAN会社概要
rehabrecruiting
4
64k
Featured
See All Featured
Bootstrapping a Software Product
garrettdimon
PRO
304
110k
Put a Button on it: Removing Barriers to Going Fast.
kastner
58
3.4k
Building a Scalable Design System with Sketch
lauravandoore
458
32k
Gamification - CAS2011
davidbonilla
79
4.9k
Happy Clients
brianwarren
96
6.6k
A Tale of Four Properties
chriscoyier
155
22k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
26
1.3k
Unsuck your backbone
ammeep
667
57k
It's Worth the Effort
3n
182
27k
The Language of Interfaces
destraynor
153
23k
How to Think Like a Performance Engineer
csswizardry
16
950
Git: the NoSQL Database
bkeepers
PRO
425
64k
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ਓͰݶք͕͋Δ ◦ ఆظతʹษڧձ͕Ͱ͖ͨΒཧ ·͔ͣ͜͜Β
ࠓͷൃද͕օ͞ΜͷΞΫγϣϯʹͭͳ͕Δ͜ͱΛف͍ͬͯ·͢ υΩϡϝϯτจԽ Ұʹͯ͠Βͣ