기술문서(technical document)의 개념/중요성/범주는 무엇일까?

기업에서 기술 문서의 중요성이 점점 대두되고 있습니다. Technical Writer의 채용공고만 봐도 작년에 비해 많이 늘어났음을 확인할 수 있고 특히 IT업계 같은 경우는 기술블로그 운영이 활발해지고 있습니다. 기술블로그 또한 기술문서의 범주에 속합니다. 

기술문서는 무엇이고 어떤 문서들이 있는지 그리고 왜 기술문서가 중요한지에 대한 글을 읽고 정리해서 공유해보려고합니다. 

기술 문서는 기술 정보를 최대한 효율적으로 이용할 수 있도록 작성된 문서 

What is technical documentation? 

기술문서란 제품을 다루는 방법, 기능, 사용법에 대한 제품 정보를 쉬운 용어를 사용해 디테일하게 설명하는 문서입니다. '기술문서'라는 게 상당히 포괄적인 의미인데, 주어진 제품의 사용방법이나 기술적인 문서, 개발 시 도출되는 문서 등 광범위한 기술 문서를 가리킵니다. 

기술문서는 일반 독자를 대상으로 작성된 문서가 아니라 개발자나 엔지니어 같은 특정 독자를 대상으로 작성된 문서입니다. 특히 기술 문서는 외부 고객 뿐만 아니라 회사 내부에서도 유용하게 사용될 수 있습니다. PM, 개발자 등이 내부에서 언제든 활용할 수 있는 문서이기 때문입니다. 

이런 기술 문서를 작성하는 사람은 '테크니컬라이터'라는 직업을 가진 사람이 될 수도 있지만 프로젝트의 개발자, PM, 관리자 등의 다른 구성원이 작성할 수도 있습니다. 

 

Why is technical documentation important? 

기술 문서는 사람들에게 제품에 대한 정보를 제공한다는 점에서 중요합니다. 제품에 대한 정보가 부족하면 사람들이 제품을 올바르게 사용할 수 없거나 제품에 대한 올바른 지식이 없어 제품을 이해할 수 없습니다. 

최종 사용자의 관점에서 기술 문서는 제품을 효과적으로 사용하는 데 도움이 되기 때문에 필수적입니다. 고객 서비스 시간을 줄이고 스스로 문제를 해결하고 질문에 대한 답을 얻을 수 있는 사용자로 이어지기 때문에 회사에 도움이 됩니다. 
내부적인 관점에서 기술문서는 사람들에게 제품에 대한 효과적인 작업에 필요한 정보를 제공합니다. 

 

What makes up technical documentation?

기술 문서는 일반적으로 크게 제품 문서와 프로세스 문서 두 가지의 범주로 나눌 수 있습니다. 

먼저 사용자 문서라고도 하는 제품 문서는 제품이 무엇인지, 어떻게 사용하는지에 대해서 설명합니다. 용자 문서는 제품이 무엇인지, 어떤 기능을 가지고 있는지, 어떻게 사용하는지를 설명합니다. 일반적으로 최종 사용자가 사용하지만 회사 내부의 엔지니어 또는 회사에 막 입사한 신입사원이 제품 기술을 이해하는데 유용할 수 있습니다. 

사용자 문서의 예시는 다음과 같습니다.

• User Guides, tutorials, how-to guides, installation & reference manuals, trouble shooting manuals, FAQ
• Release note
• User experience documents 
• API & SDK documentation
• Source code documentation

프로세스 문서는 제품 개발 프로세스를 설명하는 문서로 구성됩니다. 
프로세스 문서의 예시는 다음과 같습니다.

• General content management 
• General object & standards
• 프로젝트 계획, 개요, 방법론 및 일정
• 프로젝트 보고서, 워크플로, 결과물 
• 작업문서와 화이트 페이퍼
• 제품 출시를 위한 로드맵 및 계획

이처럼 기술 문서에는 다양한 형식이 있지만 목적은 동일하다고 볼 수 있습니다. 독자가 기술 정보를 효율적으로 이용하고 이해할 수 있도록 작성한 문서입니다. 

 

참고자료
https://slite.com/templates/technical-documentation 

https://slite.com/learn/technical-documentation