테크니컬 라이터가 알려주는 글쓰기 팁

테크니컬 라이터는 회사의 제품 관련 기술 문서나 API 문서 등을 작성하고 관리하는 일을 주로 하는 전문가입니다. 제가 직접 테크니컬 라이터 분을 만나 뵈어본 적은 없지만, 제품 상세 매뉴얼이나 기술 설계서 등을 작성하는 것으로 이해하고 있었는데요.

 

👉🏻 LINE의 테크니컬 라이터 인터뷰로 확인하기

 

요즘은 많은 IT 기업들이 자신들의 기술을 외부에 공유하는 목적으로 기술 블로그를 운영하면서, 테크니컬 라이터 분들이 기술 블로그의 글들도 관리하는 것 같더라고요.

 

이번에는 넷마블의 기술블로그를 담당하는 테크니컬 라이터의 회고록을 보면서, 개발자의 글쓰기에 관한 인사이트를 얻을 수 있었습니다. 

 

좋은 개발 문서를 작성하려면 어떻게 해야할지 그 노하우가 담긴 글인데요. 개인 기술 블로그를 운영하거나, 회사에서 기술 문서를 작성할 때 꼭 참고해 보면 좋은 팁인 것 같아 정리해 봤습니다.

 

테크니컬 라이터가 알려주는 글쓰기 팁과 추천 도구

 

✍🏻 기술 문서 작성하기 팁

• 개발 문서를 보는 대상에게 가장 익숙한 용어로 통일하는 것을 권장.
• 샘플 코드나 명령어 등은 영어 그대로 작성한다.
• 알파벳 철자가 많은 영단어는 한글로 음차 해서 표현한다. (ex. StackOverFlow = 스택오버플로우)
• 외래어 표기법이 헷갈릴 때는 표준국어대사전과 우리말샘에서 확인하기! 
• 무엇을 쓸지 키워드나 제목을 나열해 목차(ToC)를 만들어볼 것
• 예제나 샘플 코드를 먼저 정리하고 작성하기
• 명령어 기반 가이드는 명령어와 결과를 정리하면 좋다.
• 원인과 결과 관계가 맞는 논리적인 글로 작성하도록 노력한다.
• 퇴고 (글쓰기의 QA 과정) 

 

👩🏻‍💻 좋은 문서 작성 도구 기준

• 내가 글쓰기 편한 도구
• 웹페이지 변환에 용이하도록 HTML, 마크다운으로 내보내기 가능한 도구
• 버전 관리가 가능한 도구
• 글쓴이의 톱 픽(Top Pick) 도구는 Visual Studio Code!

 

넷마블 테크니컬 라이터로 일한 8개월의 회고 | 요즘IT