υΩϡϝϯςʔγϣϯΛ
 ͸͡ΊΑ͏ 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ਓͰ͸ݶք͕͋Δ ○ ఆظతʹษڧձ͕Ͱ͖ͨΒཧ૝ ·ͣ͸͔͜͜Β

ࠓ೔ͷൃද͕օ͞ΜͷΞΫγϣϯʹͭͳ͕Δ͜ͱΛف͍ͬͯ·͢ υΩϡϝϯτจԽ͸
 Ұ೔ʹͯ͠੒Βͣ