본문 바로가기
728x90

테크니컬 라이팅

 (310)
WTD 호주 2022 - 표준에 따라 기술 문서 작성하기 Shumin Chen은 싱가포르의 shufrans-techdocs라는 기술문서 전문 기업에서 STE(Simplified Technical English) 업무를 담당하고 있습니다. STE는 ASD-STE100라는 스펙으로 정의되어 있습니다. 2019년 출간된 "테크니컬 라이터가 되려는 당신에게"에서 간략하게 ASD-STE100를 소개하는 내용이 포함되어 있었습니다. WTD에서는 주로 소프트웨어 산업의 기술 문서를 중심으로 다루다 보니 국제 표준에 대한 언급은 많이 없었는데 이번 세션에서는 최근 국제 표준 관련 트렌드에 대해 다루고 있습니다. 문서화의 중요성에 대해서는 많은 산업에서 강조되고 있지만 표준에 대해서는 무시되는 경향이 있습니다. ASD-STE100 같은 표준을 따르는 것은 테크니컬 라이터, 독..
'갈피를 잡지 못하다'라고 할 때 '갈피'가 '송아지(calf)'라고? '갈피'라는 단어는 2가지 의미를 가지고 있습니다. 1. 겹치거나 포갠 물건의 하나하나의 사이. 또는 그 틈. 십칠팔 년 전의 일이 노트 갈피 속에 숨어 있다가 되살아왔다. 2. 일이나 사물의 갈래가 구별되는 어름. 갈피를 못 잡다. 첫 번째는 '책갈피' 또는 '꽃-갈피'라는 단어에서 많이 들어보았을겁니다. 사전 설명과 같은 '노트 갈피'는 뭔가 낯설어보이네요. 두 번째도 많이 사용하는 표현입니다. 뭔가 일의 방향을 정하지 못하고 혼란스러울때 '갈피를 잡지 못했다' 뭐 이런 식으로 사용합니다. 이게 한자어 같은데 사전에는 한자어가 아니라고 설명하고 있습니다. 구글에서 '갈피'의 어원을 찾아보면 아리아 인의 언어에서 갈라진 말이라고 합니다. 영어 송아지를 의미하는 'calf'라는 단어가 우리말로 정착된 것..
WTD 호주 2022 - 문서가 해커 공격의 매개체가 될 수 있다 Lilly Ryan은 독특한 커리어를 가지고 있습니다. 역사 전공으로 중세 유럽의 감시 시스템을 연구하다가 소프트웨어 엔지니어가 되었습니다. 현재는 Thoughtworks에서 보안 전문가로 일하고 있습니다. 자신이 진행하는 인터뷰 채널에 Heidi Waterhouse(Docs for Developers의 저자 중 한명)가 참여해 보안 전문가들과 테크니컬 라이터가 일하는 방식에 대해 이야기했는데 그때 얻은 아이디어를 바탕으로 강연을 진행한다고 합니다. 예를 들어 보안 전문가가 침투 시험(Penetration test)를 진행할 때 취약점을 찾기 위해 문서를 샅샅이 읽습니다. 문서를 읽는 방식은 두 가지입니다. 첫 번째는 일반 사용자들과 마찬가지로 소프트웨어의 사용법(어떤 작업을 수행하는 방법)을 알기 위해..
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 쪽 연구에 합류하면서 만들어진 자료가 많아..
반응형

티스토리툴바