above all , accurately so they will be guided by its light. - Joseph Pulitzer

테크니컬 라이팅이란

그대로 번역하면 , 기술 글쓰기를 뜻하는 테크니컬 라이팅은 무엇을 의미할까요?

이런 전문적인 개발자 분들이 쓴 글들만 테크니컬 라이팅 일까요?

간단하게 , 여러분들이 작성하는 기술에 대한 글들 역시 테크니컬 라이팅입니다.
꼭 전문적인 테크 블로그나 기술 명세만이 테크니컬 라이팅이 아닙니다!
테크니컬 라이팅의 좁은 의미는 과학 기술 정보를 정확하고 효과적으로 전달하기 위한 문서 작성 기술을 뜻합니다.
넓은 의미로는 뭘까요?
단순 과학 기술 정보를 정확하게 전달하는 글쓰기 뿐만 아니라 모든 유형 글을 분명하고 알기 쉽게 전달하는 글쓰기 입니다.

GPT 역시 우리의 테크니컬 라이팅을 응원합니다! 🔥

테크니컬 라이팅 에 대해 더 톺아보겠습니다.

일반 글쓰기 vs 테크니컬 라이팅

일반적인 문학책이나 소설책을 보면 글의 표현이나 창의적인 내용을 보며 흥미진진하게 봤을겁니다.
져 역시 , 그런 점들 때문에 책 읽는 것을 좋아했습니다. 인상깊은 책 중 하나였던 데미안 에서는 ,

새는 알을 깨고 나온다. 알은 곧 세계이다. 태어나려고 하는 자는 하나의 세계를 파괴하지 않으면 안된다 ...

이러한 구절이 있습니다. 처음 , 이 내용을 보고 놓친 내용이 있나 한참을 헤맸습니다.
두번 세번 보고 , 해석을 본 후에야 그 내용이 자신의 한계에 도전하라는 뜻임을 깨달았습니다.

하지만 , 테크니컬 라이팅이 두번 세번 보고 다른 내용을 봐야 이해되는 그런 글이면 어떨까요?
사람들이 , 욕하고 뒤로가기 하며 다른 블로그들을 찾아볼겁니다. 저 역시 그렇습니다 😢

카카오엔터프라이즈 글에서 그림을 참조했습니다 🫡

퓰리쳐 상의 창시자인 조셉 퓰리쳐의 명언 중 네가지 입니다. 이 네가지 명언은 테크니컬 라이팅에도 정확하게 접목이 됩니다.

테크니컬 라이팅은 비즈니스 와 기술 관련 문서이기 때문에 모호한 설명 보다는 , 독자가 이해하기 쉽게 명확한 기술을 해야 합니다.
또한 , 자신의 주관적인 생각 과 추측이 아닌 오직 사실 과 타당한 정보를 기반으로 사실을 전달해야 합니다.

왜 테크니컬한 글을 써야 할까

최근 들어서 테크니컬 라이팅은 매우 중요하게 되었습니다.
회사의 기술 사용 회고를 남기는 테크 블로그 도 그렇고 ,
자신들이 개발을 해나간 내용을 발표하는 테크 세미나( 우아한 테크 세미나 같은..! ) 등 매우 많은 테크니컬 커뮤니케이션이 있습니다.
이런 회사에서 작성하는 테크니컬 라이팅 부터 , 취준생 들과 공부하는 사람들이 작성하는 테크니컬 라이팅 까지 쓰는 이유는 다 비슷할 거 같습니다.

대략 쓰는 이유를 정리 해보면,
첫째 , 효과적인 의사소통
둘째 , 정보 기록과 보존
셋째 , 경쟁력 강화가 있을거 같습니다.

두번째 와 세번째에 대한 설명은 생략하고 효과적인 의사소통을 사례와 함께 설명하겠습니다.

효과적인 의사소통

예시로 , 프로젝트를 시작하기 전 작성하는 사용자 요구사항 설계 ( 일명 SRS ) 를 생각하면 될 거 같습니다.
열정이 뿜뿌한 다섯 명의 팀원이 프로젝트 시작하는 경우로 예시를 들어보겠습니다.

기획자 : 저희 이번에 테크 민족 어플에 대해서 기능을 정리해볼까요?
개발자 : 아이디어가 너무 좋은데 , 빠르게 개발 시작해서 완성 하는게 좋을꺼 같아요 ~ 🤩
기획자 : 그러면 , 매일 카톡으로 얘기하고 매주 회의로 구현할 기능 정합시다! 🔨🔨🔨
( 1달 후... )
기획자 : 저희 이번에는 민족끼리 협동하는 프리코스 기능을 만들까요?
개발자 : 어 그 기능은 경쟁하는 기능 아니였어요?
기획자 : 어 제가 한 달 전에 생각했을때는 협동 하는 기능이였는데..
다른 개발자 : 어 그런 기능도 저희가 만들기로 했나요?
다른 개발자 : ( 또 이걸로 한참 회의 하겠네 😮‍💨 )
👀👀👀

물론 , 과장된 예시이지만 충분히 있다고 생각합니다...

이렇듯 , 테크니컬 라이팅 으로 작성한 내용들은 명확하고 타당한 정보로 쓰였기에
이런 상황이 와도 , 미리 작성된 SRS 를 보며 팀원 간 정보 불일치나 오해를 없애고 , 업무 효율을 향상 시킬수 있습니다!

기획자 : 이번에는 요구사항 #27 번 모두 같이 협력하는 프리코스 기능을 만듭시다!
개발자 : 입출력 과 기능 은 나와 있는 대로 구현 하면 되죠??
기획자 : 네! 추가하거나 , 수정하고 싶은 부분은 피그마에 이모지로 남겨주세요!
다른 개발자 : 다 같이 협력하고 으쌰으쌰 하는 프리코스 기능 참 좋은 생각인거 같아요 !!!

조금 느낌이 다를수도 있지만 , 이런 맥락의 효과를 기대할 수 있을거 같습니다.
그러면 , 왜 필요한지도 알았고 , 정말 테크니컬 라이팅을 쓸 준비를 해볼까요?

글쓰기 시작 ? 📝 🤔

테크니컬 라이팅을 갑자기 시작한다고 하면 , 막막하실 껍니다.
내용을 그럴듯 하게 써야하나? 말투는 어떻게 해야하지? 생각할게 너무 많아서 귀찮고 포기하고 싶어질 수도 있습니다.
따라서 , 단계적으로 시작하는 걸 추천합니다!

독자 파악하기

우선 , 독자를 파악하는 것부터 시작을 합니다.
쉽게 생각하면 , 그냥 개발자들을 향해서 쓰면 되는거 아니야? 라고 생각하지만 개발자 들 중에서도 독자는 매우 다양할 수 있습니다.
자신의 코드를 리뷰해주는 리뷰어 , 자신이 가르쳐 줘야하는 후배 개발자 ,
쉽고 빠르게 백엔드 지식을 설명해줘야 하는 프론트 엔드 개발자 분님들 등 생각하면 끝도 없습니다!

독자를 파악해야 글의 난이도 와 배경지식 그리고 용어 설명을 어느정도 까지 할 지 정할수 있습니다.
그리고 , 독자들이 읽는 목적을 생각해서 방향성을 고려할 수 있습니다.

기껏 열심히 해서 , 이런 말이 나오면 안되니까요 🥺🥺

독자를 파악하기 위한 고려사항

1. 독자는 누구인가?
2. 독자의 목표는 무엇이며 , 이 문서를 읽는 이유는 무엇인가?
3. 독자는 문서를 읽기 전 무엇을 알고 있는가?
4. 독자는 문서를 읽은 후 무엇을 알거나 할 수 있어야 하는가?

이러한 고려사항을 생각하며 , 독자들을 정하면 이제 말투나 글의 방향성 등이 잡힐겁니다.
마침내 , 이제 글을 써봅시다

글 쓰는 법

글 쓰는 프로세스는 총 다섯 단계로 구분 됩니다.

기획 -> 구조화 -> 작성 -> 검토 -> 배포 순서 입니다.

기획

기획은 말 그대로 , 글을 본격적으로 작성하기 전 미리 세부사항 들을 다 정하는 것입니다.

• 문서 주제 , 발행 일정 및 채널 결정
• 작성하고자 하는 문서에 적합한 템플릿 & 스타일 확인
• 주제 관련된 정보 수집하고 진행 상황 추적
• 문서 작성 타임라인 과 얻게 될 결과물에 대한 가이드라인

그리고 , 이때 다같이 작성하는 경우에는 초안 작성자 도 지정합니다!

구조화

전달하고자 하는 내용을 한눈에 볼 수 있도록 목차 생성하는 단계입니다.
만약 , 초안 작성자가 지정 되면 이 작성자가 회의를 통해 목차를 만들어 나가면 됩니다.

• 전달하고자 하는 내용을 한눈에 볼 수 있도록 목차 생성

구조화 단계 까지 마치면 본격적인 글 쓰기 시간입니다.

작성

이제 , 초안을 작성할 시간입니다.

• 목차 바탕으로 관련 정보 정리 , 본격적으로 문서 작성
• 모호하거나 질문 사항이 있는 경우는 별도 기록해 사실 여부 확인해야 함

이 때 , 주의해야 할 점은 많은 시간을 할애 해야 하는 것입니다.

ISO / IEC 표준을 보면 , 문서 한 페이지 초안 작성에 한시간이 걸린다고 합니다!
추가로 , 편집하고 수정할 때는 최대 2.5시간이 든다고 합니다.

( ISO / IEC 란? : 다양한 산업 분야 걸쳐 국제 표준 개발하고 발행하는 독립적 비기관 들입니다! )

이렇게 전문적인 라이터들도 작성에 어마어마한 시간이 듭니다.
저 역시 , 공부한 내용을 쓸 때 단순히 내용을 넣고 정리 하면 30분 정도 밖에 안걸렸는데 ,
테크니컬 라이팅에 대해 공부하고 , 해당 글을 여기까지 쓰는데 벌써 3시간이 넘게 걸리고 있는데요...

여기까지 왔으면 자신이 생각하기에 , 완벽한 걸작이 완성이 됐을겁니다.

검토

하지만 , 아직은 부족한 걸작입니다.
이제 완성된 걸작을 검사 받을 때입니다!
미술 작품 역시 , 사람들마다 관점이 다르듯이 , 우리들 글 역시 보는게 다를수 있습니다.
그렇기에 , 작성된 문서를 기술적 측면과 스타일적 측면이 없는지 다른 사람들한테 확인을 받아야 합니다.

• 이해 관계자 , 관련 전문가에게 초안에 대해 의견 수집
• 이 과정 통해 , 미미한 부분 보완하고 사실 여부에 맞게 수정
• 내용 수정이 끝난 후에는 맞춤법과 오타 등 부수적 사항 재확인 해 최종본 만듬

해당 내용을 통해 , 수정 요소 및 추가 요소가 있으면 다시 작성 단계로 넘어가서 반복합니다.

배포

여기까지 왔으면 , 모두가 인정하는 걸작일겁니다. ( 꼭 걸작일 필요는 없습니다! )
이제 힘들게 작성한 결과를 보여줄 시간 입니다.

• 최종본을 기획 단계에서 정한 발행일에 맞춰 배포
• 배포할 장소 결정 ( 문서 , PDF , 웹 상 )
• 시의성 ( 시기적절 , 각 상황에 맞게 )

데미안의 글귀 처럼 , 드디어 새가 알을 깨고 세상으로 나왔습니다!

마무리 하며

공부하며 느낀점은 단순히 자신이 공부한 내용을 그냥 내용만 기록 하고 적어서 남기는 것 보단 , 명확하고 테크니컬 하게 내용을 그림과 자신만의 설명과 함께 작성하는 것이 중요하다 였습니다.

해당 내용에 대해서 더 잘 쓰기 위해서 , 여러 블로그 들을 돌아다니고 학습 내용을 정리하며 , 반복적으로 내용을 보고 제 머릿속에 내용들을 다듬을 수 있었습니다.

어린 이유로 , 자신이 공부한 내용에 대해 진심으로 테크니컬 하게 글을 써보는 것도 정말 추천합니다!

이 내용의 목표 독자는 프리코스 함께 하시는 여러분 이며 , 자세하면서도 이해하기 쉽게 최선을 다해 써봤습니다!
글 역시 , 완성본 이 아니라 아직 검토 단계라고 생각합니다. 많은 평가 부탁드립니다!!

아래에는 테크니컬 라이팅을 잘하기 위한 10 계명입니다! 감사합니다👏

휼룡한 테크니컬 라이팅 10계명

1. 사전 독자의 배경지식과 문화 등 충분한 이해!
2. 유사한 콘텐츠를 조사하고 특징을 분석합니다!
3. 독자에 따른 적합한 정보 전달 방식 채택!
4. 간결한 문장을 사용!
5. 이해하기 어려운 용어는 추가적인 설명 덧붙히자!
6. 최종적으로 독자가 얻게 되는 정보를 명확히 하자!
7. 내용의 이해도를 높이는 디자인 요소 활용
8. 시간 변화에 민감한 정보일 경우 작성 시기 또는 관련 일자 명시 - 시의성
9. 콘텐츠 배포하기에 앞서 제 3자에게 검토 받습니다.
10. 발행한 콘텐츠를 정기적으로 수정하고 업데이트 합니다.

Preference

https://www.undernamu.com/ko/insights/technical-writing-for-beginner

https://www.undernamu.com/ko/insights/google-technical-writing

https://osckorea.tistory.com/172

https://tech.kakaoenterprise.com/102

https://tech.kakaoenterprise.com/65