11월 5일
UX 라이터 커리어 패스, 어떤 것들이 있을까요?
https://capturephrase.stibee.com/p/96/
캡처프레이즈는 매주 금요일 아침 UX 라이팅 해외 아티클을 번역하는 서비스라고 합니다.
번역한 원문은 Joshua Gene Fechter가 작년 11월에 작성한 글인데 Technical Writer HQ라는 서비스를 창업한 분이기도 합니다. 테크니컬 라이팅 관련 자격증 코스를 운영하고 다양한 테크니컬 라이터와의 인터뷰를 게시하는 곳이기도 하죠. 눈치채셨겠지만 역시 약간은 마케팅 성격이 강한 글입니다.
What is the Technical Writer Career Path? 라는 글도 같이 보시면 좋겠네요.
https://www.linkedin.com/pulse/what-technical-writer-career-path-joshua-gene-fechter-yvcuc/
11월 7일
11월 WTD 뉴스레터
- Write the Docs Australia conference
11월 28, 29일 WTD 호주 컨퍼런스가 멜버른에서 진행됩니다. 참석하고자 하시는 분들은 티켓 마감이 16일 마감된다고 합니다. - WTD Salary Survey for 2024
매년 진행하는 설문조사가 진행되고 있습니다. 급여, 근무 환경 등 다양한 요소에 대한 설문을 진행합니다. 무기명 설문이긴 하지만 설문 응답으로 누군가 특정하지 못하도록 일정 수치보다 낮은 인구 통계 답변은 공개를 하지 않는다고 합니다(예를 들어 거주지가 한국이라고 한 답변자가 1명인 경우 이를 노출하지 않는다는 이야기 같습니다). - Emoji in documentation: :yes-please: or :yuk:?
온라인으로만 공개하는 문서가 많아지면서 이모지를 사용하는 경우가 늘어나고 있습니다. 문서의 시작 페이지나 새로운 제품 기능 소개 같은 곳에서 많이 사용됩니다. 하지만 이모지만 사용하게 되면 커뮤니케이션의 오류가 발생할 수 있고 접근성 등에서도 문제가 될 수 있습니다. - Are tool experience requirements a myth?
테크니컬 라이터 구인 공고에 특정 도구가 명시된 경우가 있습니다. 필수인 경우도 있고 우대사항 같은 항목으로 들어가는 경우도 있습니다. 일부 기업에서는 지원자의 이력서에 다룰 수 있는 도구 목록이 없으면 대상에서 제외하는 경우도 있다고 합니다. - Dealing with images and other assets in docs-as-code
마크다운 같은 코드 기반으로 문서를 관리하는 경우에도 이미지 등의 리소스는 별도로 관리를 해야 합니다. 때문에 용량이 많아지면 이런 리소스를 어디에서 관리해야 하는지에 대한 토론이 있었다고 합니다. 다이어그램처럼 코드로 관리하는 리소스는 코드 기반으로 전환하고 필요한 이미지는 재사용할 수 있게 잘 정리하는 것이 중요하다고 하네요. - Streamline your release notes with a template
레드햇 Brian Forté가 만든 CCFR 템플릿에 대한 소개입니다. cause, consequence, fix, result의 약자로 CCFR을 사용합니다.
깃헙 이슈에서 자동으로 릴리스 노트를 만드는 프롬프트에서도 CCFR을 사용하고 있네요. https://github.com/jwulf/release-note-poc/blob/main/CCFR.md
AI Slop Is Flooding Medium
https://www.wired.com/story/ai-generated-medium-posts-content-moderation/
https://news.hada.io/topic?id=17621
아마 요즘 구글 등에서 콘텐츠를 찾다보면 AI가 작성한 것처럼 보이는 콘텐츠가 많습니다. 국내의 경우에는 수익형 블로그라는 이름으로 다양한 강의나 교재가 판매되고 있기도 합니다. 미디엄에서는 이를 자동으로 차단하거나 수익 연계 등을 제약하는 방법으로 무분별한 AI 생성 콘텐츠를 방지한다고 합니다.
정책적으로 이를 공지하고 운영하고 있으며 AI 도구를 보조적인 수단으로 써서 사용한 경우에도 이를 명시하지 않으면 제약될 수 있다고 합니다(맞춤법, 문법 검사 등의 용도는 제외하고).
https://help.medium.com/hc/en-us/articles/22576852947223-Artificial-Intelligence-AI-content-policy
11월 12일
Writing Docs With Code Samples?
젯브레인스의 글쓰기 도구 Writerside 소식입니다.
https://blog.jetbrains.com/writerside/2024/11/writing-docs-with-code-samples-try-out-the-new-writerside-eap-release/
최근 WTD 애틀랜틱 2024 컨퍼런스 행사 중에 코드 샘플에 대한 토론이 있었나 봅니다(토론이라 영상으로 공개되지는 않았습니다). 대부분의 도구들이 뭔가 새롭고 화려한 코드 관련 기능을 추가하고 있는데 실제 사용자들이 원하는 것은 그들의 목표를 달성할 수 있게 해주는 코드 단락이라고 합니다. 많은 문서들이 인터랙티브 한 기능을 통해 코드 샘플을 제공하고 있긴 하지만 제대로 활용하기는 쉽지 않다는 불만인가 봅니다.
그래서 문서 내 코드 블록은 전체 맥락에서 사용자가 어떤 목표를 가지고 문서에 접근하는지 이해해야 하고, 바로 가져다가 사용할 수 있어야 하며, 학습 수준에 따른 리소스를 제공해야 하며, Swagger spec이나 Postman collection에 너무 의존하지 않아야 한다는 겁니다.
물론 실제 추가된 기능이 이런 요건들을 다 반영하는 건은 아니겠지만 최소한의 방향성을 가지고 가겠다는 의미가 아닌가 싶습니다.
Chris Chinchilla의 "Technical Writing for Software Developers"라는 책 이야기도 나오는데요. 올해 3월에 나온 책인데 이런 책이 나온 줄도 모르고 있었네요. 시간이 되면 살펴보도록 하겠습니다. ㅠㅠ
https://www.amazon.com/dp/B0CYL9SWZ5
11월 14일
2025 수능 국어
디퓨전 모델 관련 지문이 나온 수능 국어 문제가 화제입니다.
'노이즈' 40번 이상 반복 등장한 국어 지문…"로제 아파트냐"라는 기사도 올라와 있구요.
(지문의 특성 때문에 그럴수도 있지만 반복적이고 중복된 표현이 많기는 합니다).
https://n.news.naver.com/mnews/article/001/0015046371?sid=102
한빛 미디어에서는 "[2025 수능 국어 지문 출제] 디퓨전 모델(diffusion model) 쉽게 이해하기"라는 글로 빠르게 노를 젓고 있습니다.
https://www.hanbit.co.kr/channel/category/category_view.html?cms_code=CMS6968709109
11월 15일
2025 수능 국어 (2)
'尹 퇴진 집회 안내'로 연결된 URL이 나온 수능 국어 문제가 화제입니다.
'국어 지문'에 나온 사이트 '尹 퇴진 집회 안내'로 연결 논란
https://n.news.naver.com/article/001/0015046627
...수능 출제 기관인 한국교육과정평가원은 "확인하고 있다"며 "출제 당시 확인할 때는 그게 없었다. 문제가 공개된 후 누군가 악의적으로 한 것 같다"고 말했다...
그냥 해프닝 같지만 기술 문서를 작성할 때 주의 사항이기도 합니다.
Developing Quality Technical Information (3rd Edition)에서는 의미 없는 예시 도메인이 필요한 경우에는 IANA에서 이런 용도로 지정한 주소를 사용해야 한다고 합니다. 이번 사건처럼 문서를 작성하는 시점에는 소유권이 없는 도메인이지만 나중에 누군가 해당 도메인을 사용할 수 있기 때문이죠.
Similarly, don’t use fictitious web addresses. Even if a web address seems safe to use (that is, you checked it, and it doesn’t display a page), you can’t be sure that the web address won’t be used by somebody in the future. Instead, use one of the web addresses that have been designated by the Internet Assigned Numbers Authority (IANA) exclusively for use in examples. These web addresses are http://www.example.com, http://www.example.net, http://www.example.org, and http://www.example.edu.
깃랩 문서 스타일 가이드에서도 이런 내용을 담고 있습니다.
https://docs.gitlab.com/17.5/ee/development/documentation/styleguide/#fake-urls
뭐 물론 이렇게까지 기술 문서를 주의 깊게 봐주시고 활용(?) 하시는 분들이 있다면 고마운 일이죠 ^^
11월 18일
기술 문서에도 엔지니어링이 필요하다
https://tech.goorm.io/ko/2411_commit/
구름에서 매달 진행하는 기술 행사입니다. 11월은 "문서 엔지니어링"을 주제로 진행한다고 합니다.
11월 27일 19시 진행되는 행사구요. 선착순 접수는 아니고 신청하면 추첨을 한다고 하네요.
접수 마감은 11월 22일 금요일 17시라고 합니다.
(뭐 나중에 영상으로 올라오면 봐야지 했는데, "11월 COMMIT은 다시 보기를 제공하지 않습니다"라고 하네요).
참석하시는 분들은 발표자 전정은 님이 이전에 올리신 글을 체크해 보고 참석하면 좀 더 내용을 쉽게 이해할 수 있지 않을까 싶습니다.
- 문서 엔지니어링과 API 문서화
https://engineering.linecorp.com/ko/blog/document-engineering-api-documentation
- 주석 분석기를 이용한 간단한 API 문서화 방법
https://engineering.linecorp.com/ko/blog/comments-parsing-api-documentation
- 기술 문서 사이트로 Docusaurus 활용하기
https://techblog.lycorp.co.jp/ko/docusaurus-as-a-technical-document-website
토스 프론트엔드 개발자들이 더 이상 문서를 찾지 않는 이유
https://toss.tech/article/toss-frontend-ai-docs
사내 메신저 대화 중 중요한 내용을 PR로 올리고 이를 지식으로 활용한다는 아이디어가 흥미롭네요.
...테크니컬 라이팅도 함께 진화하고 있는데요. 이전에는 공급자 관점에서 정보를 구조화하고 특정 기능을 효과적으로 설명하는 것에 초점을 맞췄다면, 지금은 개발자가 문서를 잘 사용할 수 있는 시스템을 만드는 데 집중하고 있어요. 결국 테크니컬 라이팅의 본질은 ‘어떻게 문서로 개발자의 문제 해결을 도와줄 수 있을까’이기 때문이에요...
11월 21일
기술 문서 작성 못지 않게 ‘과정’을 고민하는 도큐먼트 엔지니어, 전정은
구름 COMMIT 소식 전하면서 미처 보지 못한 글이네요.행사 전에 사전 인터뷰를 매번 진행하나 봅니다.
...사전 인터뷰에서 미처 나누지 못한 기술 문서화 엔지니어링에 대한 이야기는 11월 COMMIT에서 들을 수 있습니다. 11월 COMMIT에서는 글을 잘 쓰는 방법이 아닌 글을 쓰고 관리하는 전체적인 프로세스와 도구 활용에 중점적으로 이야기합니다. 특히 ‘Docs as Code’를 시작하려는 분이나, 이미 시도하고 있지만 어려움을 겪은 분이 모여 서로의 고민을 나누고 해결책을 함께 모색하는 시간이 되길 바라고 있습니다...
https://tech.goorm.io/ko/%ea%b8%b0%ec%88%a0-%eb%ac%b8%ec%84%9c-%ec%9e%91%ec%84%b1-%eb%aa%bb%ec%a7%80-%ec%95%8a%ea%b2%8c-%ea%b3%bc%ec%a0%95%ec%9d%84-%ea%b3%a0%eb%af%bc%ed%95%98%eb%8a%94-%eb%8f%84%ed%81%90/
