ํ”ผ๋“œ๋กœ ๋Œ์•„๊ฐ€๊ธฐ
๐Ÿค”How Should We Write Documentations with AI in 2026? (Markdown vs HTML vs Word)
Dev.toDev.to
Frontend

AI ๊ธฐ๋ฐ˜ ๋ฌธ์„œ ์ž๋™ํ™”: md-HTML/CSS ํ•˜์ด๋ธŒ๋ฆฌ๋“œ ์„ค๊ณ„๋ฅผ ํ†ตํ•œ ํ† ํฐ ํšจ์œจ ๋ฐ ๊ฐ€๋…์„ฑ ํ™•๋ณด

๐Ÿค”How Should We Write Documentations with AI in 2026? (Markdown vs HTML vs Word)

Web Developer Hyper2026๋…„ 5์›” 16์ผ5๋ถ„beginner

AI ์š”์•ฝ

Context

๊ณ ๊ฐ์‚ฌ์˜ MS Word ์š”๊ตฌ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด AI์˜ ์ง์ ‘์ ์ธ .docx ์Šคํƒ€์ผ ์ œ์–ด ๋ถˆ๊ฐ€๋Šฅ ๋ฐ XML ๊ตฌ์กฐ๋กœ ์ธํ•œ ๋ถ„์„ ํšจ์œจ ์ €ํ•˜ ๋ฐœ์ƒ. ๊ธฐ์กด Word AI ๋„๊ตฌ๋“ค์˜ ์ƒ์„ธ ์Šคํƒ€์ผ ์ ์šฉ ์‹คํŒจ๋กœ ์ธํ•œ ์ˆ˜๋™ ์ž‘์—… ๋ณ‘๋ชฉ ์ง€์  ํŒŒ์•….

Technical Solution

  • Pandoc ๊ธฐ๋ฐ˜์˜ Word-md ์ƒํ˜ธ ๋ณ€ํ™˜ ํŒŒ์ดํ”„๋ผ์ธ ๊ตฌ์ถ•์„ ํ†ตํ•œ AI ๊ฐ€๋…์„ฑ ๋ฐ ํ† ํฐ ํšจ์œจ ์ตœ์ ํ™”
  • VS Code ๋‚ด ํ”„๋กœ์ ํŠธ ์ปจํ…์ŠคํŠธ์™€ ๊ธฐ์กด md ๋ฌธ์„œ๋ฅผ AI์— ์ฃผ์ž…ํ•˜์—ฌ ์ผ๊ด€์„ฑ ์žˆ๋Š” ์ดˆ์•ˆ ์ƒ์„ฑ ๋กœ์ง ์„ค๊ณ„
  • reference.docx ๊ธฐ๋ฐ˜์˜ ์Šคํƒ€์ผ ๋งคํ•‘ Python ์Šคํฌ๋ฆฝํŠธ ๊ฐœ๋ฐœ๋กœ ํ—ค๋”ฉ ๋ฐ ๋ถˆ๋ › ํฌ์ธํŠธ ์ž๋™ ์ ์šฉ ๊ตฌํ˜„
  • ํ…์ŠคํŠธ-๋””์ž์ธ ๋ถ„๋ฆฌ ์ „๋žต์„ ์œ„ํ•ด md(์ฝ˜ํ…์ธ )์™€ HTML/CSS(๋ ˆ์ด์•„์›ƒ)๋ฅผ ์กฐํ•ฉํ•œ ํ•˜์ด๋ธŒ๋ฆฌ๋“œ ๋ Œ๋”๋ง ๊ตฌ์กฐ ์ฑ„ํƒ
  • A4 ๊ทœ๊ฒฉ ๋ฐ Page Break ์„ค์ •์„ ํฌํ•จํ•œ HTML ํ…œํ”Œ๋ฆฟ ๊ตฌ์ถ•์œผ๋กœ ์ธ์‡„ ๋ฐ PDF ์ถœ๋ ฅ ํ˜ธํ™˜์„ฑ ํ™•๋ณด

์‹ค์ฒœ ํฌ์ธํŠธ

1. AI ๋ฌธ์„œ ์ƒ์„ฑ ์‹œ .docx ์ง์ ‘ ์ˆ˜์ •๋ณด๋‹ค md ๋ณ€ํ™˜ ํ›„ ์ฒ˜๋ฆฌํ•˜๋Š” ํŒŒ์ดํ”„๋ผ์ธ ๊ฒ€ํ† 

2. Token Efficiency์™€ Readability ์–‘๋ฆฝ์„ ์œ„ํ•ด ์ฝ˜ํ…์ธ (md)์™€ ์Šคํƒ€์ผ(CSS)์„ ๋ถ„๋ฆฌํ•˜์—ฌ ๊ด€๋ฆฌ

3. ๋ณต์žกํ•œ ๋ฌธ์„œ ์Šคํƒ€์ผ ์žฌํ˜„์„ ์œ„ํ•ด Reference ํŒŒ์ผ ๊ธฐ๋ฐ˜์˜ ์Šคํƒ€์ผ ๋งคํ•‘ ์Šคํฌ๋ฆฝํŠธ ๋„์ž… ๊ณ ๋ ค

ํƒœ๊ทธ

#Markdown#Pandoc#Document Automation#AI-driven Workflow#HTML/CSS
์›๋ฌธ ์ฝ๊ธฐ