기술 문서 너도 쓸 수 있어!

 

기술 문서를 통해 다른 사람들과 지식이나 기술을 공유하려면 명확하고 도움이 되는 방식으로 작성해야 합니다.

 

기술 문서 작성할 때 도움이 될 만한 몇 가지를 정리해 봤습니다.

 

1. 목차 작성하기

 

글쓰기를 시작하기 전에 무엇을 전달하고 싶은지, 어떻게 전달하고 싶은지에 대한 명확한 준비가 있어야 합니다.

 

목차는 생각을 정리하고 내용을 계획하는 데 도움이 될 수 있습니다.

 

목차는 구체적이고 난이도가 낮은 것부터 높은 것 순으로 정렬하면 좋습니다.

 

2. 상세 목차 작성하기

기본 목차가 있으면 더 자세한 내용으로 살을 붙여야 합니다. 상세 목차는 글을 더 빠르고 효과적으로 작성하는 데 도움이 될 수 있습니다.

 

목차에서 각 섹션에서 다룰 내용을 간략하게 요약해서 상세 목차로 만드는 것이 좋습니다.

 

3. 내용 작성하기

 

이제 상세 목차가 있으므로 기술 문서 작성을 시작할 수 있습니다.

 

기술 문서를 작성할 때는 구조를 따르면 일관되고 설득력 있는 문서를 작성할 수 있습니다.

 

예를 들어 개요, 배경, 주장, 증거, 예시 순서로 작성해서 맥락을 전달하고, 신뢰를 주는 것이 좋습니다.

 

짧은 기술 문서의 경우는 목차를 먼저 만들기보단 구조를 목차로 사용하거나 구조에 맞게 목차를 작성해도 좋습니다.

 

4. 그림이나 예제 추가하기

기술 문서를 좀 더 매력적이고 유용하게 만드는 가장 좋은 방법 중 하나는 요점을 설명하는 그림이나 예제를 추가하는 것입니다.

 

그림을 통해서 전달하고 싶은 내용을 시각화하고 실제로 어떻게 동작하는지 확인하는 데 도움이 됩니다.

 

그림은 관련성이 높고, 명확한 그림이 좋고, 그림에 대한 설명을 넣어주는 게 좋습니다.

 

5. 문서에 신뢰성 높이기

 

기술 문서 작성의 마지막 단계로 신뢰할 수 있는 정보 출처를 작성해서 기술 문서의 신뢰성을 높이는 것입니다.

 

출처를 추가하므로 해당 문서에 대한 전문성을 보여줄 수 있고, 사람들에게 추가적인 정보를 제공할 수 있습니다.

---

짧은 글 작성 예시 글

서비스의 리스크를 대비하는 위험관리

긴 글 작성 예시 글

이해하기 쉬운 코드 작성방법 한장에 정리