Technical writing

C4 ๋ชจ๋ธ๊ณผ C4-PlantUML์„ ์ด์šฉํ•œ ์†Œํ”„ํŠธ์›จ์–ด ๊ตฌ์กฐ ๋‹ค์ด์–ด๊ทธ๋žจ ๋งŒ๋“ค๊ธฐ

์ด๋ฒˆ ๊ธ€์—์„  Write the Docs Portland 2020 ์˜จ๋ผ์ธ ๋ฐœํ‘œ ์ค‘ ํ•˜๋‚˜๋ฅผ ์†Œ๊ฐœํ•˜๊ณ  ์ด ๋‚ด์šฉ์— ๋Œ€ํ•ด ์ด์•ผ๊ธฐํ•ด๋ณผ๊นŒ ํ•ฉ๋‹ˆ๋‹ค.

์†Œํ”„ํŠธ์›จ์–ด ๊ตฌ์กฐ๋ฅผ ํŒŒ์•…ํ•  ๋•Œ ๊ธ€๋ณด๋‹ค๋Š” ์†Œํ”„ํŠธ์›จ์–ด ๊ตฌ์กฐ ๋‹ค์ด์–ด๊ทธ๋žจ๊ณผ ๊ฐ™์€ ๊ทธ๋ฆผ์„ ํ†ตํ•ด ํ›จ์”ฌ ๋น ๋ฅด๊ฒŒ ์ดํ•ดํ•œ ๊ฒฝํ—˜์ด ๋งŽ์œผ์‹ค ๊ฒ๋‹ˆ๋‹ค. ๊ทธ๋Ÿฐ๋ฐ ์†Œํ”„ํŠธ์›จ์–ด ๊ตฌ์กฐ ๋‹ค์ด์–ด๊ทธ๋žจ ์ž‘์„ฑ์— ์ต์ˆ™ํ•˜์ง€ ์•Š๋‹ค๋ฉด ๋ง‰์ƒ ๊ทธ๋ฆฌ๋ ค๊ณ  ํ•ด๋„ ๊ทธ๋ฆฌ๋Š” ๊ฒŒ ์‰ฝ์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ์–ด๋–ค ๋„๊ตฌ๋ฅผ ์จ์„œ ์–ด๋–ป๊ฒŒ ์‹œ์ž‘ํ•ด์•ผ ํ• ์ง€๋„ ๊ณ ๋ฏผ๋˜๊ณ  ๊ทธ๋ฆฌ๊ธฐ ์‹œ์ž‘ํ•œ ๋’ค์—๋„ ์ด๋ ‡๊ฒŒ ๊ทธ๋ฆฌ๋Š” ๊ฒŒ ๋งž๋Š”์ง€ ์ž๋ฌธํ•  ๋•Œ๊ฐ€ ๋งŽ์œผ์…จ์„ ๊ฒ๋‹ˆ๋‹ค.

์ด๋ฒˆ ๊ธ€์—์„œ ์†Œ๊ฐœํ•  ๋ฐœํ‘œ๋Š” Avi Flax ๋‹˜์˜ Set your data free with model-based architecture diagramming ์„ธ์…˜์œผ๋กœ, ์ €์™€ ์—ฌ๋Ÿฌ๋ถ„์˜ ๊ณ ๋ฏผ์„ ์กฐ๊ธˆ์ด๋‚˜๋งˆ ํ•ด์†Œํ•  ์ˆ˜ ์žˆ์„ ๊ฒƒ ๊ฐ™์•„ ๊ณต์œ ํ•˜๋ ค๊ณ  ํ•ฉ๋‹ˆ๋‹ค.

๊ทธ๊ฒƒ์ด ์•Œ๊ณ  ์‹ถ๋‹ค – ์™œ ๊ฐœ๋ฐœ์ž๋Š” ๊ธ€์„ ๋ชป ์“ธ๊นŒ?

๊ฐœ๋ฐœ์ž๋Š” ๊ธ€์„ ๋ชป ์“ฐ๋Š” ๊ฒƒ์ผ๊นŒ? ์•„๋‹ˆ, ๊ฐœ๋ฐœ์ž๋Š” ๊ธ€์„ ์•ˆ ์“ฐ๋Š” ๊ฒƒ์ผ๊นŒ? ์•„๋‹ˆ, ๊ฐœ๋ฐœ์ž๋Š” ๊ธ€์„ ์“ฐ๊ธฐ ์‹ซ์€ ๊ฒƒ์ผ๊นŒ?

์ €๋Š” ํ˜„์ง ํ…Œํฌ๋‹ˆ์ปฌ ๋ผ์ดํ„ฐ์ด์ž ์ „์ง ๊ฐœ๋ฐœ์ž๋กœ์„œ ํ˜„์žฅ์—์„œ ๊ฒช์€ ๊ฒฝํ—˜์„ ๋ฐ”ํƒ•์œผ๋กœ ์ด ํ˜„์ƒ์„ ์‹ฌ์ธต ๋ถ„์„ํ•ด ๋ณด๋ ค๊ณ  ํ•ฉ๋‹ˆ๋‹ค. ๋‹จ, ๋ถ„์„๋งŒ์ž…๋‹ˆ๋‹ค. ๋งˆ์น˜ ๋งค๋…„ 12์›”~1์›”์— ์„œ์ ์—์„œ ๋งŒ๋‚˜๋ณผ ์ˆ˜ ์žˆ๋Š” ๋‹ค์–‘ํ•œ ์ž๊ธฐ ๊ณ„๋ฐœ์„œ ๋งˆ๋ƒฅ ์ƒ๋‹นํžˆ ์ด๋ก ์ ์ธ ๋‚ด์šฉ์„ ๋‚˜๋ˆ•๋‹ˆ๋‹ค. ๋ˆ„๊ตฐ๊ฐ€์—๊ฒ ๋งค์šฐ ๋”ฐ๋ถ„ํ•œ ์ด์•ผ๊ธฐ๊ฐ€ ๋  ์ˆ˜ ์žˆ๊ฒ ์ง€์š”. ๋ˆ„๊ตฌ๋‚˜ ๋จธ๋ฆฌ๋กœ๋Š” ์•Œ๊ณ  ์žˆ๋Š” ๋‚ด์šฉ์ด์ง€๋งŒ ์‹ค์ฒœ์œผ๋กœ ์ด์–ด์งˆ ๊ฐ€๋Šฅ์„ฑ์ด ํ˜„์ €ํžˆ ๋‚ฎ์€ ๋‚ด์šฉ ๋ง์ž…๋‹ˆ๋‹ค.

ํ…Œํฌ๋‹ˆ์ปฌ ๋ผ์ดํŒ… ์ปจํผ๋Ÿฐ์Šค: Write the Docs Prague 2018 ๋ฐฉ๋ฌธ๊ธฐ

์•ˆ๋…•ํ•˜์„ธ์š”. Clova ๊ธฐ์ˆ  ๋ฌธ์„œ ์ž‘์„ฑ ๋ฐ ๊ด€๋ฆฌ ์—…๋ฌด๋ฅผ ๋งก๊ณ  ์žˆ๋Š” Technical Writing ํŒ€ ๊ฐ•์ •์ผ์ž…๋‹ˆ๋‹ค.

Write the Docs(์ดํ•˜ WTD)๋Š” ์ปค๋ฎค๋‹ˆ์ผ€์ด์…˜, ๋ฌธ์„œ, ๊ทธ๋ฆฌ๊ณ  ์‚ฌ์šฉ์ž๋ฅผ ์—ฐ๊ตฌํ•œ ๊ฒฝํ—˜์„ ์„œ๋กœ ๊ณต์œ ํ•˜๋Š” ์ปค๋ฎค๋‹ˆํ‹ฐ์ž…๋‹ˆ๋‹ค. WTD๋Š” ํŠนํžˆ ์†Œํ”„ํŠธ์›จ์–ด ์‚ฐ์—…๊ณผ ๊ด€๋ จ๋œ ๋ถ„์•ผ์— ์ข€ ๋” ์ง‘์ค‘ํ•˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ์ด ์ปค๋ฎค๋‹ˆํ‹ฐ๋Š” ๋งค๋…„ ์ •๊ธฐ์ ์œผ๋กœ ๋ด„์—๋Š” ๋ฏธ๊ตญ ํฌํ‹€๋žœ๋“œ์—์„œ, ๊ฐ€์„์—๋Š” ์ฒด์ฝ” ํ”„๋ผํ•˜์—์„œ WTD ์ปจํผ๋Ÿฐ์Šค๋ฅผ ์—ด๊ณ  ์žˆ๋Š”๋ฐ์š”. WTD ์ปจํผ๋Ÿฐ์Šค์—์„œ ์ฐธ์„์ž๋“ค์€ ๊ฐ์ž๊ฐ€ ๋ฌธ์„œ ๋ฐ ํ”„๋กœ์ ํŠธ๋ฅผ ๊ด€๋ฆฌํ•˜๋ฉด์„œ ์–ป์€ ๊ฒฝํ—˜์„ ๊ณต์œ ํ•˜๊ณ , ์ข€ ๋” ๊ด€์‹ฌ์žˆ๋Š” ์ฃผ์ œ๊ฐ€ ์žˆ์œผ๋ฉด ํ† ๋ก ๋„ ํ•˜๋ฉด์„œ ์ƒˆ๋กœ์šด ์‚ฌ๋žŒ๊ณผ ๋‰ด์Šค๋ฅผ ์ ‘ํ•  ์ˆ˜ ์žˆ๋Š” ๊ธฐํšŒ๋ฅผ ๊ฐ€์ง‘๋‹ˆ๋‹ค.

์ด๋ฒˆ ๊ธ€์—์„œ๋Š” ์ œ๊ฐ€ ๋“ค์—ˆ๋˜ ์„ธ์…˜ ์ค‘ ๊ฐ€์žฅ ๊ธฐ์–ต์— ๋‚จ๋Š” ๋‘ ์„ธ์…˜๊ณผ ๊ฐ ์„ธ์…˜์— ๋Œ€ํ•œ ์ œ ์†Œ๊ฐ์„ ๊ณต์œ ํ•ด๋“œ๋ฆฌ๋ ค๊ณ  ํ•ฉ๋‹ˆ๋‹ค.


API the Docs ์ฐธ๊ด€ ํ›„๊ธฐ

์•ˆ๋…•ํ•˜์„ธ์š”? ํ…Œํฌ๋‹ˆ์ปฌ ๋ผ์ดํ„ฐ Serizawa์ž…๋‹ˆ๋‹ค. LINE์€ ๊ฐœ๋ฐœ์ž๋“ค์ด ์ตœ์‹  ๊ธฐ์ˆ  ๋™ํ–ฅ์„ ํŒŒ์•…ํ•  ์ˆ˜ ์žˆ๋„๋ก ํ•ด์™ธ ์ปจํผ๋Ÿฐ์Šค ์ฐธ๊ฐ€๋ฅผ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค. ์ด๋ฒˆ ํฌ์ŠคํŒ…์—์„œ๋Š” ์ œ๊ฐ€ ์ด ์ง€์› ์ œ๋„๋ฅผ ์ด์šฉํ•ด ๋‹ค๋…€์˜จ API ๋ฌธ์„œํ™” ๊ด€๋ จ ์ปจํผ๋Ÿฐ์Šค์ธ API the Docs์— ๋Œ€ํ•ด ์ „ํ•ด ๋“œ๋ฆด๊นŒ ํ•ฉ๋‹ˆ๋‹ค.

API the Docs๋Š” ํ…Œํฌ๋‹ˆ์ปฌ ๋ผ์ดํ„ฐ, API ๊ฐœ๋ฐœ์ž, ํ”„๋กœ๋•ํŠธ ์˜ค๋„ˆ, ์—๋ฐ˜์ ค๋ฆฌ์ŠคํŠธ๋ฅผ ๋Œ€์ƒ์œผ๋กœ ํ•œ API ๋ฌธ์„œํ™”์— ํŠนํ™”๋œ ํ–‰์‚ฌ๋กœ, ํ•ด๋งˆ๋‹ค ์—ฌ๋Ÿฌ ์ฐจ๋ก€, ์„ธ๊ณ„ ๊ฐ์ง€์—์„œ ์—ด๋ฆฝ๋‹ˆ๋‹ค. ๊ฐœ๋ฐœ ๊ฒฝํ—˜(Developer eXperience, ์ดํ•˜ ‘DX’)์˜ ์ค‘์š” ์š”์†Œ์ธ ๋ฌธ์„œํ™”์— ๊ด€ํ•ด์„œ ์ตœ์‹  ์šฐ์ˆ˜ ์‚ฌ๋ก€๋‚˜ ๊ฒฝํ–ฅ ๋“ฑ์„ ๊ณต์œ ํ•˜๊ณ  ์˜๊ฒฌ์„ ๋‚˜๋ˆ„๋Š” ์ž๋ฆฌ์ด์ง€์š”.

LINE ๊ฐœ๋ฐœ์ž ์‚ฌ์ดํŠธ ๊ฐœํŽธ – ๋น„ํ•˜์ธ๋“œ ์Šคํ† ๋ฆฌ

์•ˆ๋…•ํ•˜์„ธ์š”, ์ €๋Š” LINE์˜ ์„œ๋น„์Šค ์ œํ’ˆ์— ๋Œ€ํ•œ ๊ธฐ์ˆ  ๋ฌธ์„œ๋ฅผ ๋‹ด๋‹นํ•˜๋Š” ํ…Œํฌ๋‹ˆ์ปฌ ๋ผ์ดํ„ฐ, ์ผ€๋„ค์Šค ๋ผ์šฐ(Kenneth Lau)์ž…๋‹ˆ๋‹ค. ์•„๋งˆ ์ด๋ฏธ ์•„์‹œ๋Š” ๋ถ„๋“ค๋„ ๊ณ„์‹œ๊ฒ ์ง€๋งŒ, ์ €ํฌ๋Š” ์ตœ๊ทผ์— LINE ๊ฐœ๋ฐœ์ž ์‚ฌ์ดํŠธ๋ฅผ ๊ฐœํŽธํ•˜์˜€์Šต๋‹ˆ๋‹ค. LINE ๊ฐœ๋ฐœ์ž ์‚ฌ์ดํŠธ๋Š” LINE Login์ด๋‚˜ ๋ฉ”์‹œ์ง€ API ๋“ฑ LINE์ด ์ œ๊ณตํ•˜๋Š” ์„œ๋น„์Šค์— ๋Œ€ํ•œ ์ •๋ณด์™€, ์—ฌ๋Ÿฌ๋ถ„์˜ ์•ฑ์„ ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ๋Š” ๊ฐœ๋ฐœ์ž ์ฝ˜์†”์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. ๋ฌด์—‡์„ ๊ฐœํŽธํ•˜์˜€๋Š”์ง€ ๊ฐ„๋žตํ•˜๊ฒŒ ์†Œ๊ฐœํ•˜๋Š” ๊ธ€์„ ์ค€๋น„ํ•˜์˜€์œผ๋‹ˆ ๊ถ๊ธˆํ•˜์‹  ๋ถ„๋“ค์€ ํ™•์ธํ•ด ๋ณด์„ธ์š”.

์ €๋Š” ์ด๋ฒˆ ๊ธ€์„ ํ†ตํ•ด์„œ ๊ฐœ๋ฐœ์ž ์‚ฌ์ดํŠธ ๊ฐœํŽธ์— ๋”ฐ๋ฅธ ๊ธฐ์ˆ ์  ๋ณ€ํ™”์™€, ๊ธฐ์ˆ  ๋ฌธ์„œ๋ฅผ ์ž‘์„ฑํ•˜๋Š” ๊ณผ์ •์— ๋Œ€ํ•ด ๋‹ค๋ฃจ๊ณ ์ž ํ•ฉ๋‹ˆ๋‹ค. Static site generator๋ฅผ ๋„์ž…ํ•œ ๊ณผ์ •๊ณผ ์ด๋กœ ์ธํ•ด ๋ฌธ์„œํ™”์— ์ƒ๊ธด ๋ณ€ํ™”์™€ ์•ž์œผ๋กœ ์ €ํฌ๊ฐ€ ์–ด๋–ค ๊ณ„ํš์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€์— ๋Œ€ํ•ด ๋ง์”€๋“œ๋ฆฌ๊ฒ ์Šต๋‹ˆ๋‹ค. ๊ทธ ์ „์—, ์šฐ์„  ๊ฐœ๋ฐœ์ž ์‚ฌ์ดํŠธ์— ๋Œ€ํ•ด์„œ ๊ฐ„๋žตํ•˜๊ฒŒ ์†Œ๊ฐœ ๋“œ๋ฆฌ๊ฒ ์Šต๋‹ˆ๋‹ค.