한빛출판네트워크

기술문서는 소프트웨어 개발자에게 단순한 텍스트가 아닙니다. 개발에 있어 가장 효율적인 커뮤니케이션 도구이자 수단이죠. 기술문서를 어떻게 작성하느냐에 따라 프로젝트가 성공할 수도 실패할 수도 있습니다. 이 클래스에서는 팀과 고객에게 신뢰를 주는, 프로젝트를 성공으로 이끄는 효율적인 기술문서 작성 스킬을 알려드립니다.

남정현 강사님은 이 클래스를 위해 개발자로서 테크니컬 라이터 업무를 겸하며 현장에서 부딪히고 경험하며 알게 된 기술문서 작성의 핵심 노하우를 공개했습니다. 

이 클래스와 함께라면 프로젝트를 성공시키고 훌륭한 개발자로 성장하기 위해 꼭 필요한 업무 스킬을 습득할 수 있습니다.

여러분도 혹시 백지에 대한 공포가 있나요? 

백지에 대한 공포가 있다면, 기술문서가 중요하다는 것을 알고 있지만 막상 작성하려니 막막한 기분을 느껴보신 적도 있을 거예요. 이 강의에서는 그럴 때 활용할 수 있는 <업무적 글쓰기 3단계>부터 차근차근 알려드립니다. 

기술문서를 잘 작성하려면 먼저 문서의 기본 구성 요소와 구조를 이해하고 있어야 해요. 명확하고 간결한 문서를 작성하는 방법을 익히고, 독자가 쉽게 이해할 수 있는 문서 디자인과 포맷팅을 배우게 되면 기술문서의 구조가 보이거든요. 

마크다운 등의 도구를 활용해 문서를 쉽게 작성하고 효율적으로 관리하는 방법도 다룰 겁니다. 이것이 프로젝트의 품질을 한 단계 올리는데 큰 기여를 하게 될 거예요.

Part 1. 업무적 글쓰기 노하우

업무적인 글을 잘 쓰기 위한 접근 방법에 대해 알아봅니다. 모든 문서를 작성하기 전 해당 파트에서 익힌 방법을 사용해 보세요. 백지의 공포를 이겨낼 수 있습니다. 

Part 2. 현장에서 필요한 기술문서 작성 노하우

프로젝트 문서화, 주석, API 문서, 장애대응 보고서부터 회의록, 메일까지 우리가 현장에서 사용하는 문서들에 대해 알아봅니다. 그리고 AI를 활용해 조금 더 쉽게 기술문서를 작성하는 방법에 대해서도 살펴봅니다.

Part 3. 마크다운과 이를 활용한 기술문서 작성하기
마크다운 사용법을 익히고 이를 활용해 웹페이지, 블로그, PPT 등을 만들어 봅니다. 이 파트에선 여러분이 기술문서를 작성할 때 사용할 수 있는 다양한 문서화 도구에 대해 알아갈 수 있습니다. 

개발자가 되고 싶어 하는 모든 취업준비생.

기술문서 작성법을 익혀야 하는 주니어 개발자.

기술문서 작성 스킬을 통해 조금 더 성장하고 싶어하는 개발자.

프로젝트와 팀개발에 꼭 필요한 기술문서 작성법을 익히게 됩니다.