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
"Cold start" fast flow - using external suppliers to bootstrap a nimble, flow-centric organization
matthewskelton
PRO
1
180
ヒューマンエラーの本を読んだ ~報告会~
o0h
PRO
2
200
NOT A HOTEL SOFTWARE DECK
notahotel
6
63k
UTMD 修士論文報告会スケジューリングツール 解説
shunyanoda
0
1k
横浜新都市脳神経外科病院 リハビリテーション科 職員寮案内
yokohamashintoshihp
0
230
公開版_モノ売りからコト売りへ 製造業が向き合うビジネスとアジャイル
junki
1
640
Cierpa & Company | Culture Deck
cierpa0905
PRO
0
19k
ワンメディア株式会社 会社紹介資料
sakiyogoro
0
7k
Enito_with_Omiai_company_info_long
enito
PRO
0
26k
朝日新聞社 ITエンジニア キャリア採用 紹介資料
asahi_cto
0
130
会社紹介資料 | booost technologies株式会社
booost
0
650
アッテル会社紹介資料/culture deck
attelu
10
13k
Featured
See All Featured
GraphQLとの向き合い方2022年版
quramy
43
13k
How to Ace a Technical Interview
jacobian
274
23k
What the flash - Photography Introduction
edds
67
11k
The Brand Is Dead. Long Live the Brand.
mthomps
53
38k
Embracing the Ebb and Flow
colly
83
4.4k
Docker and Python
trallard
40
3k
Building Better People: How to give real-time feedback that sticks.
wjessup
359
19k
A Philosophy of Restraint
colly
202
16k
jQuery: Nuts, Bolts and Bling
dougneiner
61
7.4k
We Have a Design System, Now What?
morganepeng
48
7.1k
10 Git Anti Patterns You Should be Aware of
lemiorhan
653
59k
Statistics for Hackers
jakevdp
794
220k
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ਓͰݶք͕͋Δ ◦ ఆظతʹษڧձ͕Ͱ͖ͨΒཧ ·͔ͣ͜͜Β
ࠓͷൃද͕օ͞ΜͷΞΫγϣϯʹͭͳ͕Δ͜ͱΛف͍ͬͯ·͢ υΩϡϝϯτจԽ Ұʹͯ͠Βͣ