8월 1일
8월 첫 소식입니다. 지난 7월 27일 토스 페이먼트 트위터(이제는 엑스라고 해야 하나요 ㅠㅠ) 계정에 한글 변수명 사용에 대한 글이 올라왔습니다. "세종대왕 프로젝트"라는 이름으로 한글코딩 컨벤션에 대한 짧은 문서를 같이 공개했구요.
https://tosspayments-dev.oopy.io/chapters/frontend/posts/hangul-coding-convention
세종대왕 프로젝트 (한글 코딩 컨벤션)
한글 코딩? 어려운 도메인 용어에 대해 변수명을 정할 때, 어색한 영어보다 이해하기 쉬운 한글로 짓는 컨벤션을 말합니다.보다 이해하기 쉽고 눈에 잘 들어오는 코드를 작성할 수 있다는 장점
tosspayments-dev.oopy.io
토스에서 코딩에 한글 상수, 변수를 사용한다는 건 이미 여러 채널을 통해 알려져 있습니다. 면접을 보신 분들의 증언(?)이 있기도 하고 지난 2021년 온라인 컨퍼런스에서 공개된 내용이기도 합니다. 이때만 해도 그냥 아이디어 수준이었는데 뭔가 공개적인 문서가 노출되었다는 점에서 여러 의견이 나오는 듯합니다.
개발의 영역이라 테크니컬 라이팅과는 상관이 없을 것 같아 보이지만 조직 내에서 어떤 식으로 한글 변수명을 사용할지 정하는 과정에서 규모가 커지게 되면 전문적인 테크니컬 라이터의 개입이 필요할 수도 있습니다.
8월 17일
제목 스타일 단계는 문서 구조의 기둥과 보
https://netmarble.engineering/heading-style-guide-for-strong-document
요즘 한참 충격적이었던 사건 중 하나가 무량판 구조에서 철근이 빠진 아파트 이야기였죠. 무량판 구조라는 것이 바로 "건축구조의 한 종류로, 없을 무(無) 자, 대들보 량(梁) 자를 쓴 명칭 그대로 하중을 지탱하고 있는 수평구조 부재인 보(beam)(대들보)가 없고, 건물의 하중을 지탱하는 수직재의 기둥(코어)에 슬래브(slab)가 바로 연결된 형식"이라고 합니다.
제목 스타일을 제대로 잡지 못한 글이 어떻게 무너질 수 있는지 잘 보여주는 사건(?)이겠네요 ^^
8월 18일
https://brunch.co.kr/@wegra/27
(개앞맵시의) 이것이 번역이다
번역 원칙과 간단한 글쓰기 팁 몇 가지 | 이번 글은 제가 책을 번역하며, 더불어 다수의 책을 교정/교열하며 가꿔 온 저만의 글쓰기 원칙 혹은 노하우입니다. 원래 ‘번역의 역사’라는 더 큰 주
brunch.co.kr
(개앞맵시의) 이것이 번역이다
제목이 자극적이긴 하지만 번역을 포함한 글쓰기에 대한 글쓴이의 노하우가 차곡차곡 담겨져 있습니다.
8월 23일
유데미에 한국어로 진행하는 테크니컬 라이팅 강의가 올라왔습니다.
"기술블로그로 알아보는 테크니컬 라이팅"이라는 강의이고 우아한형제들 테크니컬 라이팅 코치인 유영경 님이 진행합니다. 테크니컬 라이터를 위한 강좌보다는 개발자를 위한 강좌에 가깝습니다.
https://www.udemy.com/course/techwriting/
흥미로운 신간이 나왔습니다.
제목은 "Docs-as-Ecosystem: The Community Approach to Engineering Documentation"입니다. Docs-as-Code의 패러디 같지만 맞습니다. 저자인 Alejandra Quetzalli는 개발자로 경력을 시작해서 2018년부터는 데브렐 조직에서 일했고 2021년부터 테크니컬 라이터로 일했습니다. 지금은 주로 오픈소스 진영 테크니컬 라이터로 여러 활동을 하고 있습니다. 그래서 커뮤니티 기반으로 문서화 작업을 진행하고 있으며 그 경험담을 공유하는 것이 아닌가 싶습니다. 나중에 책을 읽게 되면 내용은 다시 정리해 보겠습니다.
https://www.amazon.com/Docs-as-Ecosystem-Community-Approach-Engineering-Documentation/dp/1484293274
https://www.alejandraquetzalli.com/
Alejandra Quetzalli
¡Hola! 📄 I’m a Documentation Engineer. 👩🏻💻 I excel at crafting both internal and user-facing engineering documentation, tutorials, videos, and blog posts.
www.alejandraquetzalli.com
8월 31일
NHN Cloud에서 한국어로 작성된 콘텐츠를 어떻게 번역하는지를 비교적 자세하게 설명해주고 있습니다. phrase 서비스를 사용해 번역 프로젝트를 관리하고 구글 번역 API를 연동해 사용한다고 합니다. 기본적으로는 NHN Cloud 테크니컬 라이터가 영문 번역도 담당하고 있어서 한국어 콘텐츠를 교정(아마도 개발팀에서 작성한 콘텐츠의 경우)하고 자동 번역된 콘텐츠를 교정, 검수해 배포한다고 합니다.
국내에서 phrase 서비스를 얼마나 사용하는지 모르겠지만 한국어 콘텐츠를 제공하는 걸 보면 어느 정도 고객층이 있는 것으로 보입니다.
https://support.phrase.com/hc/ko
고객 사례에 넥슨(한국은 아니고 미국 법인) 사례도 보이긴 하네요.
https://phrase.com/customers/nexon-america/
NHN Cloud 기술 문서 번역 이야기
