[네이버클라우드] Technical Writing 세션 참석 후기

✍ Posted by Immersive Builder  Seong

 

 

안녕하세요. Seong 입니다. 

 

지난 10월 마지막 주, 역삼 네이버스퀘어에서 열린 테크 앰서버더 3분기 모임 행사에 다녀왔습니다. 

 

이번 행사는 기술 글쓰기 강연부터 신규 멤버 소개, 상반기 우수 활동 시상식까지 다양한 프로그램으로 진행되었는데요. 그 중에서도 네이버클라우드 이수현 리더님께서 발표하신 Technical Writing 세션이 매우 인상깊었습니다. 

 

해당 세션이 기술 콘텐츠를 발행하는 지식 공유자로서 유익한 내용이 많았기에 후기를 공유하고자 합니다. 

 

---

Technical Writing이란 무엇일까요? 

 

제가 세션을 통해 내린 정의는 이렇습니다. 

 

"Technical Writing은 기술과 사용자를 잇는 언어로 기술의 가치와 사용 방법을 명확하고 쉽게 전달하는 커뮤니케이션 활동이다." 

 

그렇습니다. 단순히 글을 쓰는 것이 아니라 기술과 사용자 사이의 간극을 메우는 활동인 것입니다. 이수현 리더님은 문학과 기술 문서를 비교하면서 Technical Writing에 대한 세션을 시작했습니다. 

 

 

문학과 기술 문서는 읽는 목적부터 다른데요. 문학은 독자가 감동과 즐거움을 느끼기 위해 읽는 글이라면, 기술 문서는 정보를 얻거나 문제를 해결하기 위해 읽는 글입니다. 즉, 시나 소설과 같은 문학 작품이 아름다운 표현과 작가의 개성을 드러내는데 초점을 둔다면, 기술 문서는 정확하고 구조화된 문장으로 일관성있게 이해를 돕는 것이 핵심입니다. 

 

 

---

이러한 Technical Writing에는 3대 원칙이 있습니다. 

 

• easy to find : 찾기 쉽게 작성하자 
• easy to understand : 이해하기 쉽게 작성하자 
• easy to use : 활용하기 쉽게 작성하자 

 

그리고 각 원칙을 어떻게 실천할 수 있는지 구체적인 항목과 노하우에 대해서 들어볼 수 있었습니다. 그 중에서 바로 적용 가능한 기억에 남는 몇 가지 항목을 정리해봅니다.  

 

첫 번째, easy to find는 글을 읽는 사용자가 시간을 절약하고 원하는 정보를 빠르게 찾을 수 있도록 작성하자는 원칙입니다. 이를 위해 정보의 구조화와 토픽 단위의 구성이 중요합니다. 핵심적이고 자주 사용하는 정보를 위 또는 앞쪽에 배치하거나 실제 사용자가 작업하는 절차에 따라 배열하여 정보를 구조화할 수 있습니다. 또한, 토픽 단위의 구성은 문서를 의미 단위로 나누는 방법인데요. 하나의 토픽에는 하나의 목적을 가진 정보만 담는 것이죠. 이렇게 하면 토픽만 떼어놓고 읽어도 어떤 내용인지 이해할 수 있습니다. 

 

두 번째, easy to understand는 사용자가 찾은 정보를 이해하기 쉽게 작성하자는 원칙입니다. 이를 위해 독자 분석, 스타일 가이드, Plain Language의 세 가지를 적용해 볼 수 있는데요. 우선 독자 분석은 글을 누가 읽을 것인지 선정하는 과정입니다. 학생이 읽을 것인지 교수가 읽을 것인지 독자의 수준에 따라 글의 난이도와 톤이 달라지기 때문이죠. 참고로 저의 경우, 초급에서 중급 기술자를 대상으로 글을 작성하고 있습니다. 다음으로 스타일 가이드는 문서 간 일관성을 유지하는 방법입니다. 용어, 문법, 포맷, 문체 등을 통일함으로써 일관성을 유지할 수 있습니다. 마지막으로 Plain Language는 복잡한 문장 대신 간결하고 짧은 문장으로 작성하는 방법입니다. 한 문장을 약 35자 내외로 작성하면 이해하기 쉬운 글이 됩니다. 

 

세 번째, easy to use는 사용자가 정보를 활용하기 쉽게 작성하자는 원칙입니다. '사용자에게 쓸모 있는 글인가? 문제를 해결하는 실효성이 있는가?' 등 사용자의 관점에서 고민하고 문서를 설계해야 합니다. 예를 들어, 글의 목적이 트러블 슈팅 경험을 공유하는 것이라면 장애 상황-예상 원인-해결 방안의 순으로 작성하는 것이죠. 이렇게 하면 사용자가 자신의 문제와 글의 상황을 비교해보고 곧바로 활용할 수 있게 됩니다. 

 

이외에도 다양한 글쓰기 기법과 유의 사항을 들을 수 있었는데요. 

정말 많은 도움이 되었습니다. 

 

---

이처럼 세션에 참석한 후기를 정리해보았습니다. 

 

지금까지 100건이 넘는 컨텐츠를 발행해왔지만, 사실 Technical Writing에 대해 깊이 고민해본 적은 없었는데요. 이번 세션을 계기로 각 원칙의 세부 항목을 점검하는 체크리스트를 작성해보고 글쓰기 습관을 되돌아보는 뜻깊은 시간이 되었습니다. 모든 항목을 한 번에 적용하기는 어렵겠지만, 저만의 스타일을 유지하면서 하나씩 실천해나갈 생각입니다. 

 

한편으로 기술 콘텐츠의 본질이 정보 제공과 문제 해결에 있을지라도 블로그라는 공간에서 독자의 흥미와 관심을 유도하고 개성을 드러내는 글의 매력은 여전히 중요하다고 생각합니다. 아무리 유용한 정보라도 모든 글이 천편일률적으로 쓰여진다면 재미없을테니까요. 그래서 저는 기술적인 정확함 속에서도 저만의 시선과 스토리텔링을 담은 글쓰기를 이어가려고 합니다. 

 

마지막으로 좋은 자리를 마련해주신 네이버클라우드 관계자분들께 진심으로 감사의 인사를 표합니다. 

---