[🏢 회사생활] 기술 문서 작성 방법

카테고리	게시글 작성 날짜	게시글 최근 수정 날짜	작성자
회사생활	2023.07.26. 21:31	2023.07.26. 21:31	Dev.Yang

 

기술 문서 초안 작성 방법

• 문서의 대상, 목적, 패턴을 정의하는 것으로 시작합니다. 문서의 목표가 문서의 제목에 드러나야 합니다.
• 문서의 개요를 만들고 제목, 단락, 목록, 안내 문구를 사용하여 구체화합니다.
• 독자는 문서를 훑어보기에 가장 중요한 정보를 먼저 제시하고 독자를 위하여 내용을 나누어서 정보를 쉽게 찾을 수 있도록 합니다.
• 유사한 문서를 여러 개를 만든다면 일관성 있는 문서를 만들 수 있도록 템플릿을 만들어 문서를 작성합니다.

 

---

🚀 REFERENCE

Docs for Developers 기술 문서 작성 완벽 가이드 : 네이버 도서