<div id="readability-page-1" class="page"><div itemprop="articleBody">
              <p><code>정답은 없지만 오답은 있다</code>는 격언은 기술 문서에도 꽤나 어울립니다. 완벽한 개발 문서는 없지만, 있는 것에 의의를 둔 문서가 너무 많습니다. 경우에 따라선 코드 작성보다 문서 작성에 더 큰 시간 투자가 필요하거, 유지 보수도 어려울 때가 많습니다. 그래서 코드만 잘 쓰면 굳이 문서가 필요 없이 코드만 읽으면 된다는 입장, 주석은 최소화해서 간결하게 적자 등 개발자 진영에선 개발 문서의 호혜를 입으면서 그렇게 호의적인 태도는 아닙니다.</p>
<p>구 <code>MicroSoft Developer Network(MSDN)</code>, 현 <code>Microsoft Docs</code>는 관리가 정말 잘 되고 있는 개발 문서지만 때때로 스펙 변경이 문서에 반영되는 딜레이가 발생 하는 등 개발 문서 관리에 어려움을 개발 문서를 찾아 읽는 매 순간 경험하는 것이 개발자들의 현실이라고 생각합니다.</p>
<p>더불어 가장 큰 이유는 완벽한 개발 문서는 없지만, 너무 많은 오답 문서 때문에 고통 받은 경험과 개발 문서 작성에 대한 체계적인 교육, 자료 부족이라고 생각합니다. 그래서 이 책은 오답을 최대한 줄일 수 있는 방법을 알려주고 있습니다.</p>
<p>개발문서에 대한 큰 가이드를 첫장에서 제시하고 각장을 거쳐 글을 완성도 있게 채워나가는 작업을 합니다. 모든 개발문서가 똑같이 작성될 수는 없습니다. 하지만 기본적으로 고려해야 할 사항은 같습니다. 코드도 상황에 맞춰 적절히 맞추듯 개발문서도 고려사항에 맞춰 기본기를 활욜 할 수 있어야 합니다. 책의 모든 과정을 착실히 수행해도 최상의 글은 나오지 않을 수 있습니다. 하지만 착실한 오답노트의 역할을 해줄 수 있는 책입니다.</p>
<hr>
<p>한빛미디어 <code>2023 도서 서평단 "나는 리뷰어다"</code>의 일원으로 도서를 제공받아 작성한 리뷰입니다.</p>

              
            </div></div>

Sihan`s Blog

정답은 없지만 오답은 있다는 격언은 기술 문서에도 꽤나 어울립니다. 완벽한 개발 문서는 없지만, 있는 것에 의의를 둔 문서가 너무 많습니다. 경우에 따라선 코드 작성보다 문서 작성에 더 큰 시간 투자가 필요하거, 유지 보수도 어려울 때가 많습니다. 그래서 코드만 잘 쓰면 굳이 문서가 필요 없이 코드만 읽으면 된다는 입장, 주석은 최소화해서 간결하게 적자 등 개발자 진영에선 개발 문서의 호혜를 입으면서 그렇게 호의적인 태도는 아닙니다.
구 MicroSoft Developer Network(MSDN), 현 Microsoft Docs는 관리가 정말 잘 되고 있는 개발 문서지만 때때로 스펙 변경이 문서에 반영되는 딜레이가 발생 하는 등 개발 문서 관리에 어려움을 개발 문서를 찾아 읽는 매 순간 경험하는 것이 개발자들의 현실이라고 생각합니다.

Docs for Developers 기술 문서 작성 완벽 가이드

댓글