10월 4일
Write the Docs Atlantic 2024 발표 영상
Write the Docs Atlantic 2024 발표 영상이 공개됐습니다. 아래 링크에서 영상을 확인하실 수 있습니다.
https://www.youtube.com/playlist?list=PLZAeFn6dfHpn8IckCiREggN0f9oWEMomW
Atlantic 컨퍼런스는 9월 22일부터 24일까지 온라인으로 진행됐습니다. 올해 마지막 컨퍼런스는 11월 28일부터 29일까지 진행되는 Write the Docs Australia 2024 입니다.
요즘은 동영상 요약 기술도 좋아져서 영상을 다 볼 시간이 되지 않는다면 요약된 텍스트로 확인하고 관심 있는 주제의 영상만 살펴보는 것도 좋겠네요.
- 온보딩 및 문서화 계획
기드온 베렌스마이어 - 기술 작가가 온보딩을 주도해야 하는 이유와 방법
(Gideon Behrensmeyer - How and Why Technical Writers should Lead Onboarding)
가야트리 크리슈나스와미, 아네트 윌리엄스 - 미로를 탐색하기: 성공적인 문서 계획을 위한 전략
(Gayathri Krishnaswamy, Annette Williams - Navigating the Maze: Strategies for Successful Documentation Planning)
크루노 골루비치 - 기술 작문의 세계에 오신 것을 환영합니다: 신입자를 위한 가이드
(Kruno Golubić - Welcome to the World of Technical Writing: A Guide for Newcomers)
- 콘텐츠 디자인 및 문서 작성
에릭 즈린스키 - 한계 없는 클릭: 누구나, 어디서든 사용할 수 있는 콘텐츠 디자인
(Eric Zrinsky - Clicks Without Limits: Content Design for Everyone, Everywhere)
사라 샌더스 - GraphQL 문서: 스키마를 넘어서
(Sarah Sanders - GraphQL Docs: Beyond the Schema)
클로이 굿트먼 - 형태소에서 원고까지: 언어학이 어떻게 더 나은 작가가 되도록 도울 수 있는가
(Chloe Guttmann - From morphemes to manuscripts: how linguistics can make you a better writer)
다이애나 브레자, 레나 라리오노바 - 우리는 작가지 디자이너가 아닙니다: 다이어그램-코드로 조직을 차단 해제하기
(Diana Breza, Lena Larionova - We’re writers, not designers: Unblocking your organization with diagrams-as-code)
수잔 암스트롱 - 템플릿이란 무엇이며 어떻게 만들 수 있는가
(Susan Armstrong - What Is a Template and How Can I Create One)
- 문서화 엔지니어링 및 로컬라이제이션
매니 실바 - RAGs to Riches: 우리의 콘텐츠가 검색 증강 생성(Retrieval Augmented Generation)에 미치는 영향
(Manny Silva - RAGs to Riches: How Our Content Affects Retrieval Augmented Generation)
알리 도와이르 - 단어에 담긴 의미: 쿠버네티스 문서를 아랍어로 현지화하면서 배운 교훈
(Ali Dowair - What's in a Word? Lessons from Localizing Kubernetes Documentation to Arabic)
로나 미첼 - DevOps와 문서의 통합
(Lorna Mitchell - DevOps Your Docs)
10월 7일
ESLint now officially supports linting of JSON and Markdown
ESLint가 마크다운에 대한 linting을 지원합니다.
이전에는 마크다운 문서 내 코드 블럭에 대해서만 검사하는 기능(eslint-plugin-markdown)을 지원했는데 마크다운 문법에 대한 전반적인 linting을 지원한다고 합니다.
https://eslint.org/.../2024/10/eslint-json-markdown-support/
https://github.com/eslint/markdown
10월 14일
New document tabs in Google Docs provide a better way to organize your documents
구글 문서에 문서 탭 기능이 추가됐습니다.
https://workspaceupdates.googleblog.com/2024/10/tabs-in-google-docs.html
간단한 문서 작업 시에는 큰 차이가 없는데 구글 문서에서 분량이 많은 문서 작업을 하거나 작업 업무가 나누어지는 경우 각 섹션을 명확하게 정리하고 작업할 수 있다고 합니다.
50만 달러를 벌었지만, 콘텐츠는 나쁜 비즈니스라고 생각해요
https://news.hada.io/topic?id=17228
https://swizec.com/blog/it-made-me-500k-but-i-think-content-is-a-bad-business/
제목이 인상적이어서 살펴보았는데요. 프로그래밍 관련 콘텐츠를 구입하는 이들 중 80%는 이를 열어보지도 않는다는 것이 인상적이네요. 아마도 본인이 직접 구입한 것이 아니라 회사 등의 지원을 받아서 그런 것일까요?
...You make a bunch of sales and 80% of your buyers never open the thing. Then a few months later you launch it again. This may sound annoying, but it's not. A growing audience means many of them are seeing your thing for the first time and think it's new...
10월 21일
TCN 밋업 2024년 10월 행사 신청
TCN 밋업 2024년 10월 행사 신청 페이지가 열렸습니다. 잔여석이 7석 남았네요.
10월 밋업은 2개의 세션이 준비되어 있습니다.
- LINE과 Yahoo의 사내 용어집 ‘Words’ 이야기(Line Plus 김지현 님)
- github.dev로 간소화하는 개발자들과의 문서 협업(MEGAZONE CLOUD 남정현 님)
https://event-us.kr/tcn/event/93079
소프트웨어 엔지니어 가이드북(게르겔리 오로스, 이민석 역)
한빛 미디어에서 펴낸 "구글 엔지니어는 이렇게 일한다"와 비슷한 내용을 담고 있습니다. "구글 엔지니어..."는 챕터에 따라 너무 구체적으로 들어가서 어려운 부분이 있는데 이 책은 기본적인 내용을 다루고 있습니다.
원서의 제목은 "The Software Engineer's Guidebook: Navigating senior, tech lead, and staff engineer positions at tech companies and startups"입니다. 소프트웨어 엔지니어가 어떤 일을 하는지 살펴보고자 하는 테크니컬 라이터에게도 적절한 책이 아닌가 싶습니다. 다만 책이 좀 두껍네요 ^^
문서화 관련해서는 13장 "소프트웨어 엔지니어링"에서 "문서" 항목이 있고 "문서" 항목에서 언급된 "디자인 문서, RFC 및 아키텍처 문서"에 대해 15장 "소프트웨어 아키텍처"에서 다시 다루고 있습니다.
저자는 "Documentation is a high-leverage activity"라고 언급하면서 문서화는 기술 부채를 크게 줄이는 데 도움이 되는 활동이라고 강조하고 있네요.
https://www.hanbit.co.kr/store/books/look.php?p_code=B2570473158
아래는 원서 기준 13장, 15장에서 문서화 관련 항목 목록입니다.
- Documentation
Design documents/request for comment documents
Test plans, rollout plans, migration plans
Interface and integration documentation
Release notes
Onboarding documentation
A team "handbook"
Oncall runbook documentation
User manuals and guides
Documentation is a high-leverage activity
- Design Documents, RFCs and Architecture Documents
The goal of RFCS
Benefits
Reviewing RFCs
Architecture documents
10월 24일
써드아이시스템, 테크니컬 라이팅으로 차별화 전략
보도자료에 "기술 문서" 또는 "테크니컬 라이팅"이라는 키워드가 등장하는 것이 흔치 않은 일입니다.
써드아이시스템은 네이버 클라우드 프리미엄 파트너사로 고객 지원을 위해 기술 문서에 많은 투자를 하고 있다고 합니다.
...써드아이시스템은 자체 기술 문서 개발에 4년을 쏟았다. 내부에 전담 부서가 있다. 단순 기록이 아니라 비용 절감, 신규 이용자 유치 등 여러 부문에서 서비스 회사에 필요한 데이터와 현실적인 방안이 담겼다...
기사 본문만으로는 다 알 수 없지만 기술 문서 활동이 실제 기업의 이익과 연계되는 수치를 가지고 있는 것이 아닌가 싶습니다.
아쉽게도 기술 문서 콘텐츠는 고객에게만 제공되어 로그인이 필요하네요. HUGO, Lotus Docs 기반으로 만들어진 것으로 보입니다.
https://thelec.kr/news/articleView.html?idxno=30681
https://docs.3rdeyesys.com/
2024년 필수 기술 문서 작성 소프트웨어 및 도구 10가지
제목은 그럴듯하지만 제품 홍보를 위한 낚시성 콘텐츠입니다. 다만 Speedwrite 같은 도구는 동작 방식이 인상적이긴 합니다. 아마도 대부분 영어 등 몇몇 언어에 최적화된 콘텐츠를 만들어주는 것이라 한국어 사용 시 얼마나 도움이 될지 모르겠으나 점점 이런 도구들이 늘어나는 듯합니다.
한국어 블로그는 아마도 DeepL을 사용해 자동 번역된 결과 같은데, 첫 문장의 번역이 좀 애매합니다. 원문은 "Technical writers capture and translate complex information into straightforward, user-friendly documents."인데 번역은 "테크니컬 라이터는 복잡한 정보를 간단하고 사용자 친화적인 문서로 캡처하고 번역합니다"으로 되어 있어서 "문서로 캡처하고"라는 이상한 표현이 나왔습니다. 오히려 구글 번역기 결과 "기술 작가는 복잡한 정보를 포착하여 간단하고 사용자 친화적인 문서로 변환합니다."가 좀 더 잘 옮긴 번역 같네요.
https://clickup.com/ko/blog/72953/technical-writing-tools
10월 28일
Senior Technical Writer 채용 공고
오늘 올라온 따끈따끈한 채용 공고입니다. 자세한 내용은 링크를 참고하세요.
https://careers.linecorp.com/ko/jobs/2392
담당업무
- LINE GAME PLATFORM 파트너용 개발 문서 및 사업/QA 가이드라인 작성(한국어, 일본어)
- LINE GAME Developers 문서 사이트 개선
- 사내 기술 문서 작성 및 관리
- 문서화 프로세스 개선 연구
자격요건
- 소프트웨어 테크니컬 라이팅 경력 5년 이상이신 분
- 한국어와 일본어로 기술 문서를 작성한 경험이 있으신 분
- 복잡한 개념을 명확하고 간결한 언어로 풀어내는 능력이 있으신 분
- 자율적으로 일하고 논의에 적극적으로 참여하시는 분
- 해외 출장 및 근무에 결격 사유가 없으신 분
우대사항
- IT 관련 전공자 또는 개발 경력 3년 이상인 분
- Git 워크플로로 문서를 작성하고 리뷰하는 데 익숙하신 분
- 여러 명의 이해관계자와 일하면서 업무를 조율하는 데 능숙하신 분
- 사용자의 요구사항을 파악하여 문서를 구성하거나 사이트 구조를 설계한 경험이 있으신 분
- 외국어로 업무진행이 가능하신 분 (일본어)
