본문 바로가기

728x90

테크니컬 라이팅

(309)
WTD 포틀랜드 2023 - 테크니컬 라이팅에 AI 활용하기 발표자는 Rokt라는 전자상거래 관련 솔루션 회사에서 테크니컬 라이터로 일하고 있습니다. 딱히 AI 관련된 기술에 가까이 있는 것은 아니고 개인적인 관심을 가지고 이런 저런 것들을 찾아보고 시도해보았다고 합니다. AI가 일상적으로 쓰인 것이 최근 일인 것 같지만 사실 검색어 입력 시 자동 완성이라든지 맞춤법 검사, 문법 검사 같은 장치들은 꽤 오래전부터 사용하고 있었습니다. 물론 이러한 것들을 의도적으로 쓰지 않는 분들도 있지만요. 기계 번역도 마찬가지입니다. 어떤 방식을 사용하든 AI가 어느 정도 개입하고 있었던 것들이죠. 테크니컬 라이터가 AI를 통해 얻을 수 있는 이점 - 생산성의 향상(반복직인 작업은 AI에게 맡기고 전체적인 문서 구조화 등 작업에 집중할 수 있음) - 콘텐츠 품질 향상(문법, 맞..
마이크로소프트 언어 포털이 없어졌어요 예전에는 별도 사이트로 제공이 되었습니다(아래 이미지는 web.archive.org에서 가져온 것이라 스타일 등은 좀 다를 수 있습니다. 뭐 대충 이런 스티일이었습니다). 저는 http://www.microsoft.com/ko-kr/language 링크를 북마크 해놓고 방문하곤 했는데요. 오늘 용어 하나 확인할 것이 있어 사이트를 방문했더니 https://learn.microsoft.com/en-us/globalization/reference/microsoft-language-resources 링크로 연결이 되더군요. 관련 내용을 찾아보니 얼마 전부터 서비스가 중단된다는 공지가 있었다고 하더라구요. 중간중간 링크를 찾아보면 기존 제공하던 용어집, UI 번역, 스타일 가이드 등은 모두 제공하고 있습니다. ..
사서함이 거의 가득 찼습니다 스팸 메일입니다. 스팸 필터를 사용하는 경우에는 대부분 스팸으로 걸러낼 겁니다. 안랩에서도 관련된 내용을 정리한 적이 있네요. https://asec.ahnlab.com/ko/15910/ 메일 사서함 업데이트 위장한 피싱메일 주의!! - ASEC BLOG ASEC 분석팀은 메일 사서함 업데이트로 위장한 악성 메일이 국내에 유포 중인 것을 확인하였다. 사용자 이메일 계정을 포함한 사서함 업데이트 제목으로 유포 중이며, 첨부된 링크를 클릭하도록 asec.ahnlab.com "사서함"이라는 표현 때문에 스팸이다 싶었습니다. "사서함"이라는 것이 흔하게 쓰는 표현이 아니라고 생각했던 거죠. 하지만 그건 저만의 착각이었나 봅니다(사서함으로 편지 보내던 옛날 사람이라 그런가 봅니다). 일단 IT 용어사전에서는 el..
voting check 문서 빌드 시 테스트 항목 중 voting check라는 항목이 있습니다. The tests do not run any grammar or spell checkers because a voting check must always be accurate. 단어의 의미만으로 해석하면 투표를 통해 일정 비율 찬성을 하면 통과하는 건가 싶었는데(같은 문서 내 Voting test라는 표현도 있습니다. 이건 진짜 찬반 투표를 통해 통과하는 테스트) 구글에서 검색을 해보면 위키피디아 "Literacy test"로 연결해 줍니다. https://en.wikipedia.org/wiki/Literacy_test 대충 해석해 보면 1960년대 이전까지 투표를 진행하기 전에 유권자들의 문해력을 테스트하고 통과된 이들에게만 투..
WTD 포틀랜드 2023 - 데이터 기반으로 문서 관리하기 두 명이 세션을 진행하는 경우는 흔한 건 아닌데 Alex는 테크니컬 라이터이고 Lauren은 분석가입니다. 주제가 데이터를 기반으로 문서 관리하기이기 때문에 어떤 식으로 데이터를 분석하고 이를 콘텐츠 유지 관리에 반영했는지 설명합니다. 아쉬운 것은 발표하는 내용이 자신의 분야에 딱 맞아떨어지는 건 아닌 것 같고 좀 애매하게 섞여 있어서 정신이 없긴 하네요. 지금은 DigitalOcean이라는 클라우드 컴퓨팅 기업에서 일하고 있습니다. 유지 관리 대상을 두 가지로 구분하고 있습니다. 하나는 정기적으로 점검해야 하는 기존 콘텐츠이고 하나는 문서화되지 못한 것을 발견하고 만들어야 하는 콘텐츠입니다. 정기적인 점검은 18개월 기준으로 업데이트되지 않는 콘텐츠를 찾고(이때 구글 Looker를 사용한다고 합니다) ..
WTD 포틀랜드 2023 - 규범주의와 기술주의 음. WTD에서 이런 주제를 다루다니요. 워낙 다양한 배경을 가진 분들이 참여하다 보니 그럴 수 있습니다(Ed도 대학에서 언어학을 가르치다가 테크니컬 라이터로 최근에 일하기 시작했다고 합니다). 일단 Descriptivism(기술주의) 技術이 아니라 記述이라고 합니다. 그 반대(상대)적인 개념은 Prescriptivism(규범주의)이구요. 언어 변화에 대해 옳고 그름을 규정할 것인지(규범주의), 쓰이는 것을 모두 포괄할 것인지(기술주의) 이렇게 구분할 수 있습니다. 언어규범은 사회적으로 언어에 대해 옳다고 여겨지는 형식이고 예를 들면 맟춤법, 사전 등을 들 수 있다고 합니다. 주로 영어에 대한 이야기라 한국어 기준에서는 좀 애매할 수 있는데 테크니컬 라이터로서 언어규범을 어떻게 적용해야 할지 결정하는 것..
WTD 포틀랜드 2023 - 이미지를 적절하게 사용하기 Caitlin은 주로 교육(개발자 교육) 업무를 담당하다가 몽고DB 문서팀에 합류하게 되었다고 합니다. 이전에 교육 과정 개발 등의 일을 했던 경험이 있어서 학습 이론에 따라 사용자가 정보를 좀 더 쉽게 인지할 수 있게 이미지를 적절하게 사용하는 방법을 소개합니다. 뭐 특별한 내용이 있는 것은 아니고 기본적으로 알고 있는 내용들입니다. 복잡하게 설명한 문장을 간단한 이미지 하나로 설명할 수 있다든지, 이미지(특히 구조도 같은)를 작성할 때 일관성을 유지한다든지, 텍스트에 하이라이트를 추가하거나 선에 색상을 추가하는 등의 작업이 필요합니다. 예를 들면 아래와 같은 텍스트를 When you want to connect to an API, the first thing you need to do is ident..
WTD 포틀랜드 2023 - 자동화가 다 좋은 건 아닙니다 Dan은 엔지니어링 배경을 가지고 있으며 여러 분야에서 일을 하다가 지금은 소프트웨어 쪽에서 일하고 있고 문서 작성 특히 API 문서화 관련된 일을 하고 있습니다. API 문서화와 관련해서 다음과 같은 목표를 가지고 있습니다. - 일관성: 누가 어디서 작성을 하든 조직 내 API 문서는 같은 형식으로 작성되고 배포되기를 원합니다. 특히 마이크로 서비스 아키텍처인 경우 각 서비스를 개발하는 조직이 달라지면서 일관성을 잃어버릴 수 있습니다. - 명확성: 최신의 코드 정보를 API 문서가 담고 있어야 합니다. 틀린 내용이 없고 정확한 내용을 포함해야 합니다. 업데이트되지 않거나 오래된 문서에 대한 이야기는 다른 곳에서도 많이 들을 수 있는 이야기입니다. 개발팀과의 관계에 있어서 개발팀의 배포 기준에 문서화를 ..

반응형