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.4k
ドキュメンテーションを はじめよう
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
42
20k
メルカリ・メルカリShopsのCRE
naopr
0
590
3ヶ月で20万行を消すためにやったこと
naopr
17
16k
Technique to delete unused codes
naopr
0
1.6k
Other Decks in Business
See All in Business
DNX Ventures Japan|Introduction Deck
natsumidnx
0
730
「+ Joy」 初めは熱々だったはずなのに だんだん硬くて冷たくなっていく目標に 血を通わせる工夫_2024年度下期アップデート版
sasakendayo
0
160
(16枚)組織と集団の違いとは? 組織の「3要素」とは?
nyattx
PRO
3
2.1k
デジタルで創れ!未来の東京消防庁
tokyo_metropolitan_gov_digital_hr
1
300
合議で決めたいわけではないけれど、 集合知で助けてほしい。_pmconf_2024
tomosooon
1
5.1k
会社紹介資料 / ProfileBook
gpol
4
25k
ドローンを活用した汚泥焼却炉内点検のDX
tokyo_metropolitan_gov_digital_hr
0
320
Azure Functions HTTPトリガーにおけるタイムアウトでハマったこと
recruitengineers
PRO
2
150
WED Company Guide
wed
2
43k
デジタルツールを活用した収用委員会運営プロジェクト
tokyo_metropolitan_gov_digital_hr
0
260
ログラス会社紹介資料 / Loglass Company Deck
loglass2019
7
250k
enechain company deck
enechain
PRO
8
94k
Featured
See All Featured
Large-scale JavaScript Application Architecture
addyosmani
510
110k
How GitHub (no longer) Works
holman
311
140k
How To Stay Up To Date on Web Technology
chriscoyier
789
250k
GraphQLとの向き合い方2022年版
quramy
44
13k
Building Adaptive Systems
keathley
38
2.3k
A Philosophy of Restraint
colly
203
16k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
33
1.9k
Done Done
chrislema
181
16k
KATA
mclloyd
29
14k
Agile that works and the tools we love
rasmusluckow
328
21k
Making Projects Easy
brettharned
116
5.9k
GraphQLの誤解/rethinking-graphql
sonatard
67
10k
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ਓͰݶք͕͋Δ ◦ ఆظతʹษڧձ͕Ͱ͖ͨΒཧ ·͔ͣ͜͜Β
ࠓͷൃද͕օ͞ΜͷΞΫγϣϯʹͭͳ͕Δ͜ͱΛف͍ͬͯ·͢ υΩϡϝϯτจԽ Ұʹͯ͠Βͣ