본문 바로가기

728x90

테크니컬 라이팅

(307)
WTD 호주 2022 - 커뮤니티 주도 문서화 프로젝트 이끌기 Sarah Rainsberger는 오픈소스 프로젝트 astro의 문서 작성 책임자입니다. astro에 합류하기 전에는 교육계에서 일했다고 합니다. 과외 같은 수업도 진행했는데 커뮤니티 주도로 문서를 작성하는 astro에서는 그런 역할이 필요했나 봅니다. 가이드를 제공하고 작성한 글을 첨삭해 주는 역할입니다. https://docs.astro.build/en/getting-started/ 문서가 기술적으로 정확한 것만으로는 충분하지 않습니다. 문서는 커뮤니티의 요구를 충족시켜야 합니다. astro는 커뮤니티 주도로 문서를 작성합니다. 여기에는 3가지 원칙이 있습니다. 협업, 적용, 참여입니다. - 협업 깃헙을 통해 문서 소스 코드를 공개하고 문서화 프로세스를 확인할 수 있습니다. 그리고 어느 정도 문서화가..
TCN 2023년 2월 밋업 정리 2월 16일 저녁 8시부터 진행된 행사입니다. 온라인으로 진행됐고 Q&A는 채팅을 통해 진행했다고 합니다. 오전까지는 밋업이 있다는 것을 생각하고 있었는데 저녁 식사 이후에 머릿속에서 일정이 사라져 버렸네요. 그래서 다음 날 유튜브 영상으로 봤습니다. 때문에 Q&A에서 어떤 이야기가 오고 갔는지 알 수 없습니다. 데브시스터즈 남정현 아마 이미 읽어보신 분들도 많을텐데 '개발자에서 기술 작가로 전직하기까지 2년 간의 이야기'의 주인공입니다. 단순한 전직이 아니라 팀을 만들어가는 과정이 담겨 있어서 테크니컬 라이팅 조직이 없거나 혼자서 일하고 있다면 참고할만한 내용입니다. 물론 커뮤니티에서 꽤 오랫동안 활동을 해왔었고 사내에서도 어느 정도 영향력을 가지고 있던 분이라 가능했던 일일 수도 있습니다만 ^^ ht..
'enable'이라는 단어를 한국어로 번역하면서 '활성화'라는 표현을 사용하는데 이게 맞는 표현인가요? IT 분야 기술 문서를 보면 뭔가를 활성화하거나 비활성화한다는 표현이 자주 등장합니다. 어떤 속성이나 기능을 권한 또는 설정에 따라 사용할 수 있게 하거나 사용하지 못하게 하는 것이죠. 영어에서는 'enable', 'disable'이라는 표현을 사용합니다. '활성화'라는 표현을 사전에서 찾아보면 5가지 설명이 나오는데 단순하게 사용 여부를 설정하는 것과는 다른 의미를 담고 있습니다. 1. 사회나 조직 등의 기능이 활발함. 또는 그러한 기능을 활발하게 함. 2. 생명 생체나 생체 물질이 그 기능을 발휘함. 또는 그런 일. 3. 화학 복사 에너지의 흡수, 방전, 입자살 충격 따위에 의하여 분자, 원자, 이온 따위의 에너지를 높여 화학 반응을 일으키기 쉬운 상태로 됨. 또는 그런 일. 4. 생명 촉매 따위에서..
2023년 2월 테크니컬 라이팅 이런 저런 소식 2월 3일 ChatGPT 등의 도구를 활용해서 블로그 콘텐츠 작성, 발행을 자동화하는 영상입니다. 이게 가능한 거야 싶었는데 정말 놀랍네요. 물론 개인 블로그이고 실험적으로 하는 것이라 그렇지만 이런 식으로 자동화된 콘텐츠가 폭주하게 되면 기존 콘텐츠에 미치는 영향도 어느 정도 생기지 않을까 싶습니다. 요즘 구글 검색 결과를 보면 사람이 스팸성 콘텐츠가 눈에 띄게 늘어나고 있는데 이런 환경의 영향이라고 볼 수 있구요. https://youtu.be/GjuFZSSei0o https://youtu.be/oVUHrs83S34 https://youtu.be/hlcwOrWNFiQ 이걸로 만든 블로그는 https://www.mindfulmosaic.me/ 라고 합니다. 2월 6일 DeepL 무료 번역 서비스에 한국..
WTD 호주 2022 - 테크니컬 라이터로 성장하기 위해 필요한 이론적인 지식들에 대해 Lana Novikova는 젯브레인에서 테크니컬 라이터로 일하고 있습니다. 젯브레인에서는 writerside라는 기술 문서 작성을 위한 솔루션을 만들었고 현재 일부 사용자에게 공개 중입니다. 10년 차 테크니컬 라이터이며 테크니컬 커뮤니케이션에 대한 멘토링도 하고 있습니다. 학생들을 좀 더 잘 가르치기 위해 인지 심리 등 필요한 이론적인 지식을 따로 시간을 내 배우고 있습니다. 이번 영상은 아마도 이런 학습 과정에서 배운 것들을 문서화와 연결해서 설명하는 부분입니다. 좀 더 많은 자료는 UX 또는 UX Writing 이나 교육 쪽에서 많이 찾아볼 수 있습니다. 교육 분야는 워낙 오랫동안 연구된 분야이기도 하고 UX의 경우는 리학이나 다른 분야에 있던 분들이 UX 쪽 연구에 합류하면서 만들어진 자료가 많아..
WTD 호주 2022 - 테크니컬 라이팅과 고객 여정 관리 살짝 맛본 경험에 대해 Hari Priya는 인도 BCREC에서 엔지니어링을 공부하는 학생이고 졸업반이라고 합니다. 오픈소스와 테크니컬 라이팅에 관심을 가지고 Fedora 오픈 소스 프로젝트 문서화를 시작으로 RedHat에서 테크니컬 라이팅 인턴을 했고 Google Season of Docs 프로그램에도 참여했다고 합니다. 현재는 HackerRank에서 테크니컬 라이팅 인턴으로 일하고 있습니다. https://github.com/haripriya9647 haripriya9647 - Overview Documentation Intern @RedHat|GDSC Lead | Chapter Lead GS DGP - haripriya9647 github.com 강연에서 이야기하는 customer journey mapping은 RedHa..
테크니컬 라이터를 위한 Udemy 강의 추천 - Learn API Technical Writing: JSON and XML for Writers 부제는 "API Documentation 1: Teaches technical writers how to document structured data. No programming experience required."입니다. 프로그래밍 경험이 전혀 없는 테크니컬 라이터에게 API가 무엇이고 왜 사용하는지. 구조적 데이터가 무엇이고 JSON, XML이 무엇인지 아주 간략하게 설명합니다. 그리고 구조적 데이터를 가지고 간단한 문서를 만드는 과정까지 진행합니다. Swagger나 XSD 같은 용어가 등장하긴 하지만 구체적으로 어떻게 다루는 것인지 알려주지는 않습니다. 그냥 이런 것이 있다 정도로만 언급하고 필요하면 관련 과정을 수강하세요. 그런 느낌입니다. 강사는 Peter Gruenbaum이고 SDK Brid..
테크니컬 라이터를 위한 Udemy 강의 추천 - Technical Writing: How to Write Software Documentation 부제는 'Learn a proven strategy for writing software docu in GitHub wiki based on the 12 main principles of technical writing!'입니다. 최근 일부 강의를 업데이트하면서 DITA 대신 마크다운으로 실습하는 것으로 내용이 수정됐습니다. 2019년과 2023년의 배울 내용을 비교해 보면 살짝 달라진 부분을 확인할 수 있습니다. 강사는 Jordan Stanchev 이지만 'JPDocu School of Technical Writing'이라는 이름으로 강의는 올라옵니다. JPDocu School의 실제 강사는 혼자 하는 거라서 그냥 뭔가 이름만 걸고 있는 것이 아닌가 싶습니다. Jordan Stanchev는 테크니컬 라..

반응형