Upgrade to Pro — share decks privately, control downloads, hide ads and more …

ドキュメンテーションを はじめよう

ドキュメンテーションを はじめよう

2024/05/29に開催された Designing Documentation Culture #1 - Notionと学ぶ、ドキュメント文化 でLTした資料です。

Avatar for Naoto Sato

Naoto Sato

May 29, 2024
Tweet

More Decks by Naoto Sato

Other Decks in Business

Transcript

  1. Θͨ͠ͱυΩϡϝϯτʢձࣾʣ DeNA (500ਓˠ2000ਓ) 2011 ϝϧΧϦ (500ਓˠ2000ਓ) 201 7 ϚΠϕετ (200ਓ)

    2023 ήʔϜͷֆίϯςͱ࢓༷ॻ ݸਓɾ෦ॺ୯Ґͷۀ຿৘ใ ٞࣄ࿥ ݸਓɾ෦ॺ୯Ґͷۀ຿৘ใɺٞࣄ࿥
  2. • ೥ʑॏཁ౓্͕͕͍ͬͯΔ ◦ ϦϞʔτϫʔΫ ◦ ඇಉظίϛϡχέʔγϣϯ • Ͳͷձࣾ΋೰Έ͕͋Δ ◦ πʔϧબఆ

    ◦ υΩϡϝϯςʔγϣϯจԽͷৢ੒ ◦ ӡ༻ϧʔϧͷ࡞੒ɾపఈ • ۜͷ஄ؙ͸ͳ͍ υΩϡϝϯςʔγϣϯʹ͍ͭͯࢥ͏͜ͱ
  3. ۜͷ஄ؙ͸ͳ͍ʂͰ΋ϕετϓϥΫςΟε͸͋Δ GitLab • ΞϓϦέʔγϣϯ։ൃࢧԉπʔϧΛఏڙ͢Δձࣾ • ੈք࠷େɾ࠷ઌ୺ͷϦϞʔτ૊৫ ◦ ੈք67ΧࠃҎ্ɺࣾһ2000໊Ҏ্ ◦ ΦϑΟεΛ࣋ͨͳ͍

    • ૊৫ͷϧʔϧΛʮGitLab Handbookʯʹू໿ ◦ ໿3000ϖʔδ ◦ Web্ʹެ։͞Ε͓ͯΓ୭Ͱ΋ӾཡՄೳ GitLabʹֶͿ ੈք࠷ઌ୺ͷϦϞʔτ૊৫ͷͭ͘Γ͔ͨ - https://www.shoeisha.co.jp/book/detail/9784798183916
  4. • ৘ใͷਖ਼֬͞ɿਓؒͷهԱ <<< ه࿥ • ఻ୡͷ༰қ͞ɾޮ཰ ◦ ˕ ه࿥ɿࣗ෼ͰݕࡧͰ͖ΔɺϦϯΫΛڞ༗͢Δ͚ͩ ◦

    ✕ هԱɿຊਓʹ࣭໰͢Δඞཁ͕͋Δ 1. ʮ͔͢ΕͨΠϯΫ͸઱໌ͳهԱʹউΔʯ ϑΥʔϚοτ΍ݴ͍ճ͠Λؾʹͤͣ·ͣॻ͘͜ͱ͕େࣄ
  5. • ຊͷதͰʮٞࣄ࿥ʯ͸11ճ΋ొ৔͍ͯ͠Δ͘Β͍ॏཁ • ϝϦοτ͕ଟ͍ ◦ ࢀՃͯ͠ͳ͍ਓͰ΋಺༰͕֬ೝͰ͖Δ ◦ ೝࣝͷෆҰக͕ى͜Γʹ͍͘ ◦ ҙࢥܾఆͷಁ໌ੑ͕୲อ͞ΕΔ

    • ϛʔςΟϯάલͷ४උ͕େࣄ ◦ ٞࣄ࿥ʹΞδΣϯμΛॻ͘ ◦ ΧϨϯμʔʹٞࣄ࿥Λఴ෇͢Δ 2. ϛʔςΟϯά͸ඞͣٞࣄ࿥Λ࢒͢ ͜ΕΒΛపఈ͢Δ
  6. • GitLabͷόϦϡʔͷ1ͭʹʮಁ໌ੑʯ͕͋Δ ◦ ίϥϘϨʔγϣϯͷଅਐ ◦ ૊৫ͷ݈શੑҡ࣋ • ެ։ͯ͠͸͍͚ͳ͍΋ͷΛఆٛ͢ΔSAFEϑϨʔϜϫʔΫ ◦ Sensitive

    - ηϯγςΟϒ ◦ Accurate - ਖ਼֬ͳ৘ใ ◦ Financial - ࡒ຿৘ใ ◦ Effect - Өڹ 3. σϑΥϧτ͸ެ։ઃఆ ެ։NGͳ΋ͷҎ֎͸શͯެ։