Design Doc の書き方 / How to Write a Design Doc (Ja ver.)

Slide 1

Slide 1 text

Munetoshi Ishikawa Design Doc ͷॻ͖ํ

Slide 2

Slide 2 text

͜ͷηογϣϯͷ஫ҙ఺ Design doc ʹ͸༷ʑͳελΠϧ΍ํ๏࿦͕͋Δ - ͜ͷηογϣϯͰ঺հ͢Δ͜ͱ͸ 1 ྫʹա͗ͳ͍ - ΧελϚΠζ͕ඞཁʹͳΔ͔΋  

Slide 3

Slide 3 text

ιϑτ΢ΣΞ։ൃͰΑ͋͘Δ໰୊ - ࣮૷ऴྃؒࡍʹઃܭ্ͷ໰୊͕ൃ֮  → ΄΅࠷ॳ͔ΒίʔυΛॻ͖௚͠  - ݸʑͷϓϧϦΫΤετ͸ LGTM  → ίʔυશମͱͯͯ͠ҙຯෆ໌ Design doc Λॻ͘͜ͱͰղܾͰ͖Δ͔΋

Slide 4

Slide 4 text

τϐοΫ - Design doc ͷ֓ཁ - Design doc ͷߏ੒ - ӡ༻࣌ͷ஫ҙ఺ - έʔεελσΟ

Slide 5

Slide 5 text

τϐοΫ - Design doc ͷ֓ཁ - Design doc ͷߏ੒ - ӡ༻࣌ͷ஫ҙ఺ - έʔεελσΟ

Slide 6

Slide 6 text

Design doc ͷ֓ཁ - Design doc ͱ͸ - ʮԿΛʯॻ͔͘ - ʮ͍ͭʯॻ͔͘ - ৄࡉઃܭॻͱͷҧ͍

Slide 7

Slide 7 text

Design doc ͷ֓ཁ - Design doc ͱ͸ - ʮԿΛʯॻ͔͘ - ʮ͍ͭʯॻ͔͘ - ৄࡉઃܭॻͱͷҧ͍

Slide 8

Slide 8 text

Design doc ͱ͸ 1/2 ιϑτ΢ΣΞઃܭॻͷҰछ - ʮͲ͏࣮૷͢Δ͔ʯ͕য఺ - ։ൃऀʹΑͬͯॻ͔ΕΔ

Slide 9

Slide 9 text

Design doc ͱ͸ 2/2 ࣮૷Λߦ͏લʹॻ͘υΩϡϝϯτ - ࣮૷લʹઃܭʹ͍ͭͯٞ࿦ - ࣮૷த΋ΞοϓσʔτՄ design doc ࣮૷ “Twemoji” ©Twitter, Inc and other contributors (Licensed under CC-BY 4.0) https://twemoji.twitter.com/

Slide 10

Slide 10 text

Design doc ͷར఺ ੜ࢈ੑɾϓϩδΣΫτͷ੒ޭ཰ͷ޲্ - ϑΟʔυόοΫαΠΫϧͷ୹ظؒԽ - ࣮૷લͷ໰୊఺ͷચ͍ग़͠ - ίετݟੵ΋Γͷώϯτ

Slide 11

Slide 11 text

Design doc ͷ֓ཁ - Design doc ͱ͸ - ʮԿΛʯॻ͔͘ - ʮ͍ͭʯॻ͔͘ - ৄࡉઃܭॻͱͷҧ͍

Slide 12

Slide 12 text

Design doc ͷয఺ ʮͲ͏࣮૷͢Δ͔ʯʹয఺Λ౰ͯΔ - ໰୊఺ͱղܾࡦͷ໌֬Խ - νʔϜϝϯόʔͱͷٞ࿦ - ίϯςΩετʢഎܠ΍ܦҢʣͷه࿥

Slide 13

Slide 13 text

ؔ࿈͢ΔιϦϡʔγϣϯ 1/2 Կɾͳͥ: ࢓༷ɾ໨తͷ໌֬Խ - PRD (Product Requirements Document) ͩΕɾ͍ͭ: λεΫɾϚΠϧετʔϯ؅ཧ - Πγϡʔ؅ཧπʔϧɾϓϩδΣΫτ؅ཧπʔϧ 

Slide 14

Slide 14 text

ؔ࿈͢ΔιϦϡʔγϣϯ 2/2 ৽ϝϯόʔ޲͚ࢿྉɾݱঢ়આ໌ - νϡʔτϦΞϧɾελʔτΨΠυɾΞʔΩςΫνϟจॻ

Slide 15

Slide 15 text

Design doc ͷϖʔδ਺ ௕ͯ͘΋े਺ϖʔδఔ౓ - ୹ͯ͘ࡁΉͳΒͦΕʹӽͨ͜͠ͱ͸ͳ͍ - 20 ϖʔδҎ্ͷ৔߹ → λεΫɾϓϩδΣΫτΛ෼ׂ͢Δ

Slide 16

Slide 16 text

Design doc ͷ֓ཁ - Design doc ͱ͸ - ʮԿΛʯॻ͔͘ - ʮ͍ͭʯॻ͔͘ - ৄࡉઃܭॻͱͷҧ͍

Slide 17

Slide 17 text

͍ͭ design doc Λॻ͘΂͖͔ ʮԿΛ͢Δ͔ʯ͕͋Δఔ౓ܾ·͔ͬͯΒɺ࣮૷Λ։࢝͢Δલ த௕ظతͳϓϩδΣΫτɾλεΫʹ͍ͭͯॻ͘ - υΩϡϝϯτ࡞੒ࣗମ΋Φʔόʔϔου  = ؆୯ͳ 1 ߦͷόάमਖ਼Ͱ͸ॻ͔ͳ͍

Slide 18

Slide 18 text

͍ͭ design doc Λॻ͘΂͖͔ (cont.) Design doc Λॻ͘ج४ͷྫ: - 2 िؒҎ্͔͔ΔλεΫ - ෳ਺ͷϦϦʔεʹ·͕ͨΔϓϩδΣΫτ - ଟ਺ͷϞδϡʔϧɾΫϥεʹӨڹ͢Δमਖ਼

Slide 19

Slide 19 text

Design doc ͷ֓ཁ - Design doc ͱ͸ - ʮԿΛʯॻ͔͘ - ʮ͍ͭʯॻ͔͘ - ৄࡉઃܭॻͱͷҧ͍

Slide 20

Slide 20 text

΢ΥʔλʔϑΥʔϧͱͷൺֱ: ڞ௨఺ τοϓμ΢ϯͳΞϓϩʔν - ࣮૷ͷલʹઃܭ - จॻͷϨϏϡʔɾٞ࿦ design doc ࣮૷ + ϨϏϡʔɾٞ࿦ “Twemoji” ©Twitter, Inc and other contributors (Licensed under CC-BY 4.0) https://twemoji.twitter.com/

Slide 21

Slide 21 text

࣮૷ͱͷڥք͕ݫ֨Ͱ͸ͳ͍ - ࣮૷୲౰ऀɾνʔϜʹΑͬͯॻ͔ΕΔ - ׬ᘳͳৄࡉ͸ٻΊͳ͍: ੩తݕূͷলུɾ։ൃதͷΞοϓσʔτ - ΞδϟΠϧ։ൃʹ΋ద༻Մೳ ΢ΥʔλʔϑΥʔϧͱͷൺֱ: ૬ҧ఺ design doc ࣮૷ ୲౰ऀ “Twemoji” ©Twitter, Inc and other contributors (Licensed under CC-BY 4.0) https://twemoji.twitter.com/

Slide 22

Slide 22 text

Design doc ͷ֓ཁ: ·ͱΊ - Design doc ͸ιϑτ΢ΣΞઃܭॻͷҰछ - ʮͲ͏ʯ࣮૷͢Δ͔ʹয఺Λ͋ͯΔ - தɾେن໛ͳ࣮૷Λ࢝ΊΔલʹॻ͘ - ࣮૷தʹߋ৽͠ಘΔ

Slide 23

Slide 23 text

τϐοΫ - Design doc ͷ֓ཁ - Design doc ͷߏ੒ - ӡ༻࣌ͷ஫ҙ఺ - έʔεελσΟ

Slide 24

Slide 24 text

Design doc ͷϑΥʔϚοτ ߲໨ʹରͯ͠ʮݫີͳʯϑΥʔϚοτ͸ͳ͍͜ͱ͕ଟ͍ - ඞཁे෼ͳ߲໨ͰηΫγϣϯΛߏ੒͢Δ - ʮϑΥʔϚοτΛຒΊΔ͜ͱʯΛ໨తԽ͠ͳ͍

Slide 25

Slide 25 text

యܕతͳ design doc ͷߏ੒ - ໨తɾΰʔϧʢ΄΅ඞਢʣ - എܠ - ઃܭͷ֓ཁ - ৄࡉઃܭ - ͦͷଞͷؔ৺ࣄ τοϓμ΢ϯʹཧղͰ͖Δߏ੒ʹ͢Δ

Slide 26

Slide 26 text

యܕతͳ design doc ͷߏ੒ - ໨తɾΰʔϧʢ΄΅ඞਢʣ - എܠ - ઃܭͷ֓ཁ - ৄࡉઃܭ - ͦͷଞͷؔ৺ࣄ

Slide 27

Slide 27 text

໨తɾΰʔϧ ਺จͰʮԿΛ࣮ݱ͢Δͷ͔ʯΛఆٛ͢Δ - ʮ…ػೳΛ࣮૷͢ΔͨΊͷɺσʔλετΞͱͦͷϞσϧΛ࣮૷͢Δʯ - ʮ…ΛϓϩμΫτ಺Ͱར༻Մೳʹ͢ΔϥΠϒϥϦΛ࡞੒͢Δʯ - ʮ…ΛϦϑΝΫλ͠ɺ…ͷػೳ௥ՃΛ༰қʹ͢Δʯ

Slide 28

Slide 28 text

໨తɾΰʔϧ: ஫ҙ఺ ௕͘ॻ͖͗͢ͳ͍ - ඞཁͳΒ͹ PRD Λผ్༻ҙ - ʮ࣮૷͢ΔՁ஋͕͋Δ͔ʯ΋جຊతʹ͸ PRD Ͱٞ࿦ είʔϓΛ໌֬ʹ͢Δ - ඞཁʹԠͯ͡ʮout of scopeʯ΍ʮࠓޙͷ༧ఆʯΛ໌ه

Slide 29

Slide 29 text

యܕతͳ design doc ͷߏ੒ - ໨తɾΰʔϧʢ΄΅ඞਢʣ - എܠ - ઃܭͷ֓ཁ - ৄࡉઃܭ - ͦͷଞͷؔ৺ࣄ

Slide 30

Slide 30 text

എܠ ਺ஈམҎ಺Ͱ࣮૷͢Δཧ༝ɾલఏ஌ࣝɾ੍໿Λઆ໌ - ͜ͷ࣮૷ɾϦϑΝΫλϦϯά͕ඞཁͳཧ༝ɾར఺ - ༻ޠɾٕज़తഎܠ - ༏ઌ͢΂͖߲໨: ֦ுੑɾؤ݈ੑɾੑೳ…

Slide 31

Slide 31 text

എܠ: ஫ҙ఺ ௕͘ॻ͖͗͢ͳ͍ - ؔ࿈จॻʢPRDɾଞͷ design docʣ౳ͷϦϯΫΛར༻ ໨తɾΰʔϧͷޙʹॻ͘ - ʮԿʹ͍ͭͯ࿩͍ͯ͠Δ͔ʯΛઌʹཧղͤ͞Δ

Slide 32

Slide 32 text

എܠ: ஫ҙ఺ (cont.) ૝ఆಡऀΛҙࣝ͢Δ - ͦͷػೳɾϓϩμΫτʹؔΘ͍ͬͯͳ͍ਓ΋ର৅͔ ͦͷػೳͷ։ൃऀ ͦͷϓϩμΫτͷ։ൃऀ ಉ͡୲౰ྖҬ৬छͷ։ൃऀ “Twemoji” ©Twitter, Inc and other contributors (Licensed under CC-BY 4.0) https://twemoji.twitter.com/

Slide 33

Slide 33 text

యܕతͳ design doc ͷߏ੒ - ໨తɾΰʔϧʢ΄΅ඞਢʣ - എܠ - ઃܭͷ֓ཁ - ৄࡉઃܭ - ͦͷଞͷؔ৺ࣄ

Slide 34

Slide 34 text

ઃܭͷ֓ཁ ઃܭͷॏཁͳ෦෼ʹ͍ͭͯॻ͘ɾඳ͘ - ࣮૷ͷجຊతͳΞΠσΟΞ - ؆ུԽͨ͠ΫϥεਤɾϞδϡʔϧߏ੒ਤ - ॏཁͳཁૉͷྻڍͱઆ໌

Slide 35

Slide 35 text

ઃܭͷ֓ཁ: جຊతͳΞΠσΟΞ ࣮૷ࠔ೉ͳ఺ɾؾΛ͚ͭΔ΂͖఺ͷղܾ๏Λࣔ͢ - ʮ…͕ະ஌Ͱ͋ΔͨΊɺαΠζՄมͳ LRU ΩϟογϡΛ࢖͏ʯ - ʮ…ͷ॥؀ґଘͷղܾʹ SeviceLocator Λ࢖͏ʯ - ʮ…ͷಠཱੑͷ֬อͷͨΊʹ Layer A ͱ B Λ෼཭͢Δʯ

Slide 36

Slide 36 text

ઃܭͷ֓ཁ: ؆ུԽͨ͠Ϋϥεਤ ॏཁͳΫϥεɾϞδϡʔϧͱͦͷؔ܎ੑΛࣔ͢ - खඳ͖ɾ؆ུԽͨ͠ϑΥʔϚοτ΋Մ

Slide 37

Slide 37 text

ઃܭͷ֓ཁ: ஫ҙ఺ ࡉ͔͘ॻ͖͗͢ͳ͍ - ॏཁͰͳ͍ཁૉΛؒҾ͘ - ಛʹ஫ҙ͢Δ΂͖͜ͱʹয఺Λ౰ͯΔ ؆ུԽ

Slide 38

Slide 38 text

యܕతͳ design doc ͷߏ੒ - ໨తɾΰʔϧʢ΄΅ඞਢʣ - എܠ - ઃܭͷ֓ཁ - ৄࡉઃܭ - ͦͷଞͷؔ৺ࣄ

Slide 39

Slide 39 text

ৄࡉઃܭ ʮઃܭͷ֓ཁʯΛΑΓৄࡉʹॻ͘ɾඳ͘ ཁૉ͝ͱɾݟΔ֯౓͝ͱʹηΫγϣϯΛ࡞Δ - ཁૉ͝ͱ: ϞδϡʔϧɾΫϥεɾίϯϙʔωϯτɾϨΠϠ - ݟΔ֯౓͝ͱ: ঢ়گ΍৚݅ɾλΠϜϥΠϯɾAPI

Slide 40

Slide 40 text

ৄࡉઃܭ: ߲໨ྫ - Ϟδϡʔϧ͝ͱͷ֓ཁઆ໌ɾΫϥεਤ - ϞσϧΫϥεɾσʔλߏ଄ͷҰཡ - API ͷϦετɾ࢖༻ྫͷίʔυ - యܕతͳσʔλϑϩʔɾγʔΫΤϯεਤ - ٖࣅίʔυ

Slide 41

Slide 41 text

యܕతͳ design doc ͷߏ੒ - ໨తɾΰʔϧʢ΄΅ඞਢʣ - എܠ - ઃܭͷ֓ཁ - ৄࡉઃܭ - ͦͷଞͷؔ৺ࣄ

Slide 42

Slide 42 text

ͦͷଞͷؔ৺ࣄ ϓϩδΣΫτͷਐΊํɾӨڹൣғɾ஫ҙ఺౳ʹؔ͢Δิ଍

Slide 43

Slide 43 text

ͦͷଞͷؔ৺ࣄ ϓϩδΣΫτͷਐΊํɾӨڹൣғɾ஫ҙ఺౳ʹؔ͢Δิ଍ - ୲౰ऀ - େ·͔ͳλεΫͷखॱ - ϦϦʔεɾϞχλϦϯάϓϥϯ

Slide 44

Slide 44 text

ͦͷଞͷؔ৺ࣄ ϓϩδΣΫτͷਐΊํɾӨڹൣғɾ஫ҙ఺౳ʹؔ͢Δิ଍ - ະղܾͷ໰୊ɾ੍ݶ - ଞʹӨڹΛड͚ΔϞδϡʔϧ - ηΩϡϦςΟɾϓϥΠόγʔɾύϑΥʔϚϯε

Slide 45

Slide 45 text

యܕతͳ design doc ͷߏ੒ - ໨తɾΰʔϧʢ΄΅ඞਢʣ - എܠ - ઃܭͷ֓ཁ - ৄࡉઃܭ - ͦͷଞͷؔ৺ࣄ

Slide 46

Slide 46 text

Design doc ͷߏ੒: ·ͱΊ ඞཁे෼ͳ߲໨Ͱߏ੒͢Δ - ʮ໨తɾΰʔϧʯ͸΄΅ඞਢ - ֎෦ͷυΩϡϝϯτͳͲ΋ར༻ τοϓμ΢ϯʹཧղͰ͖Δߏ੒ʹ͢Δ - ໨త → എܠ - ઃܭͷ֓ཁ → ৄࡉઃܭ

Slide 47

Slide 47 text

τϐοΫ - Design doc ͷ֓ཁ - Design doc ͷߏ੒ - ӡ༻࣌ͷ஫ҙ఺ - έʔεελσΟ

Slide 48

Slide 48 text

Ξϯνύλʔϯ 1 1. ʮ׬ᘳͳʯ design doc Λॻ্͖͛Δ 2. ϨϏϡʔͷϛʔςΟϯάʹ 10 ਓҎ্ট଴ 3. ٞ࿦தʹઃܭͷ໰୊͕ൃ֮ 4. ࠷ॳ͔Β design doc Λॻ͖௚͢

Slide 49

Slide 49 text

ٞ࿦ͷλΠϛϯά ٞ࿦ͱ design doc ࡞੒Λަޓʹߦ͏ ࠷ॳͷٞ࿦͸… - ʮগਓ਺Ͱʯ: ςοΫϦʔυͱͷ 1-on-1 ͔Β࢝Ίͯ΋Α͍ - ʮղܾҊ͕ͳͯ͘΋ʯ: ٞ࿦ͰղܾҊΛݟ͚ͭΕ͹Α͍ - ʮ΄΅നࢴͰ΋ʯ: ٞࣄ࿥తʹ design doc Λॻ͘͜ͱ͕Ͱ͖Δ

Slide 50

Slide 50 text

Ξϯνύλʔϯ 2 1. Design doc ͷ࡞੒ɾϨϏϡʔ͕׬ྃ 2. ࣮૷Λ։࢝ 3. ࣮૷தʹઃܭͷ໰୊͕ൃ֮ 4. ઃܭΛมߋ͠ͳ͍Α͏ʹ ͦͷ৔͠ͷ͗ͷղܾࡦΛ࠾༻

Slide 51

Slide 51 text

Design doc ߋ৽ͷλΠϛϯά ࣮૷தʹ΋ઃܭΛมߋͯ͠΋Α͍ ୹͍αΠΫϧͰʮͲ͏ղܾ͢Δ͔ʯΛٞ࿦͢Δ - ඞཁͳΒ͹ design doc Λߋ৽͢Δ

Slide 52

Slide 52 text

Ξϯνύλʔϯ 3 1. ઃܭมߋͷ౓ʹ design doc Λߋ৽ 2. ʮελʔτΞοϓΨΠυʯͱ͠΋࠶ར༻ 3. ଟେͳίετ͕ඞཁʹͳΔ - ৽نϝϯόʔ͸େྔͷ design doc ΛಡΉඞཁ͕͋Δ - ܰඍͳมߋͰ΋େྔͷ design doc ͷߋ৽͕ඞཁʹͳΔ

Slide 53

Slide 53 text

Design doc ͷ੹೚ൣғ Design doc ͸جຊతʹ͸࢖͍ࣺͯ - 1 ϓϩδΣΫτͰ 1 design doc - ΞʔΧΠϒ΍ʮܦҢΛ஌Δख͕͔Γʯʹ͸ͳΔ - ଞͷબ୒ࢶΛߟྀ: ΞʔΩςΫνϟจॻɾPRDɾνϡʔτϦΞϧ

Slide 54

Slide 54 text

Ξϯνύλʔϯ 4 1. ػೳ։ൃͷϓϩδΣΫτ͕׬ྃ 2. …਺Χ݄ޙ… 3. ػೳ௥ՃͷϓϩδΣΫτ͕ൃ଍ 4. Ҏલͷ design doc ͕୳ͤͳ͍

Slide 55

Slide 55 text

Design doc ͷτϨʔαϏϦςΟ Design doc ͷϦϯΫΛ׆༻ - ϓϧϦΫΤετ͔ΒࢀরՄೳʹ - Πγϡʔνέοτ͔ΒࢀরՄೳʹ Design doc ͷϦετΛ࡞Δ - ख࡞ۀͰ؅ཧ͢ΔΑΓ΋࢓૊ΈͰ؅ཧ

Slide 56

Slide 56 text

ӡ༻࣌ͷ஫ҙ఺: ·ͱΊ - ٞ࿦ɾϨϏϡʔͷαΠΫϧ͸୹Ίʹ - ࣮૷தʹ΋ design doc ͸ߋ৽Մ - Design doc ʹʮଞͷ໾ׂʯΛ௥Ճ͠ͳ͍ - ޙ͔Β design doc ΛࢀরͰ͖ΔΑ͏ʹ

Slide 57

Slide 57 text

τϐοΫ - Design doc ͷ֓ཁ - Design doc ͷߏ੒ - ӡ༻࣌ͷ஫ҙ఺ - έʔεελσΟ

Slide 58

Slide 58 text

έʔεελσΟ ʮઃఆը໘ʯͷϦϑΝΫλϦϯάͷґཔ ௨஌ ը࣭ઃఆ Ξχϝʔγϣϯ << Φϯ >> << ߴը࣭ >> << ϑϧ >>

Slide 59

Slide 59 text

ґཔ࣌ͷϛʔςΟϯά ґཔΛड͚Δ࣌఺Ͱ໨త΍എܠΛ໌֬ʹ͢Δ

Slide 60

Slide 60 text

ϦϑΝΫλϦϯάର৅ͷௐࠪ ݱࡏͷঢ়ଶΛ೺Ѳɾ໰୊఺ͷચ͍ग़͠

Slide 61

Slide 61 text

ϦϑΝΫλϦϯάର৅ͷௐࠪ (cont.) ݱࡏͷঢ়ଶΛ೺Ѳɾ໰୊఺ͷચ͍ग़͠ - ໨తɾഎܠΛ۩ମԽ͢Δ

Slide 62

Slide 62 text

ઃܭํ਑ͷٞ࿦ ςοΫϦʔυͱͷ 1-on-1 ͳͲͰઃܭҊΛٞ࿦͢Δ

Slide 63

Slide 63 text

௥Ճɾߋ৽ඞཁͳ߲໨ 1/2 ໨తɾഎܠ - ઃܭҊΛݩʹ۩ମԽ λεΫϓϥϯ - ͲͷॱͰ࣮૷͢Δ͔ - ϦϑΝΫλϦϯάதʹ௥Ճ͞Ε߲ͨ໨ͷऔΓѻ͍

Slide 64

Slide 64 text

௥Ճɾߋ৽ඞཁͳ߲໨ 2/2 ςετ - ϢχοτςετͰݕূ͢Δ಺༰ - ϦάϨογϣϯςετͷํ๏ ߲໨௥Ճ࣌ͷखॱ - αϯϓϧίʔυ

Slide 65

Slide 65 text

έʔεελσΟ: ·ͱΊ ٞ࿦ͷ͍ͭͰʹॻ͘ͱָ

Slide 66

Slide 66 text

·ͱΊ Design doc: ιϑτ΢ΣΞઃܭॻͷҰछ - υΩϡϝϯτͷ੹೚ൣғΛ໌֬ʹ - ඞཁͳ߲໨Λඞཁͳ͚ͩॻ͘ - ୹͍αΠΫϧ͕ॏཁ

Slide 67

Slide 67 text

Appendix 1: πʔϧ ڞಉฤूɾཤྺɾίϝϯτ΍ϨϏϡʔ͕Ͱ͖Ε͹ԿͰ΋ྑ͍ - Atlassian conﬂuence, Notion - GitHub Gist, markdown in repository - Google docs, Dropbox Paper, Box notes

Slide 68

Slide 68 text

Appendix 2: Design doc ͷྫ Chromium design docs - https://www.chromium.org/developers/design-documents Bazel design docs - https://github.com/bazelbuild/proposals