본문 바로가기
728x90

테크니컬 라이팅

 (353)
목적과 목표 갑자기 objective와 goal의 차이가 궁금해서 자료를 찾아보다가 흥미로운 글을 찾았습니다. 먼데이닷컴이라는 협업 솔루션 블로그인데요. 보통 글로벌 업체는 본사 블로그를 그대로 해석하거나 자체 콘텐츠를 만드는데 여기는 본사 블로그 콘텐츠를 한국 사정에 맞게 수정해서 콘텐츠를 만들고 있더군요. 일단 원문은 "Goal vs. objective: what’s the difference?"라는 글입니다. https://monday.com/blog/project-management/goal-vs-objective/ Goal vs. objective — are they the same? | monday.com Blog Learn the difference between a goal vs. an objectiv..
API The Docs 2020 - 개발자 포털 사이트 개발 시 페르소나 활용하기 Louis Debatte-Monroy는 TOMTOM 개발자 제품 마케팅 책임자입니다. TOMTOM은 지도 관련 솔루션을 개발하는 기업입니다. 2004년 1세대 내비게이션 장치를 만들었다고 하네요. 지금도 꽤 많은 사용자를 보유하고 있는 듯합니다. 지도, 길안내 관련 SDK, API를 제공하고 있고 개발자 포털 사이트를 운영하고 있습니다. 이번 발표는 개발자 포털 사이트(https://developer.tomtom.com/)를 개발하면서 페르소나를 활용한 사례를 발표하고 있습니다. https://youtu.be/BJSa5UyZB9k 디테일하게 개발자 포털 내에서 API 문서를 페르소나 또는 독자에 대한 정의를 통해 세분화해서 만든 그런 이야기는 아니고 해커, 엔지니어, 스타트업 CEO, PM 4가지 유형에..
API The Docs 2020 - API 코드를 테스트하기 Milecia McGregor는 conducto의 개발자 애드보케이트입니다. conducto는 데이터 과학 파이프라인을 만들기 위한 플랫폼 기업입니다(정확히 뭘 하는 회사인지는 잘 모르겠습니다 ㅠㅠ https://www.conducto.com/ 를 참고하세요). API 문서를 제공하는 경우 실제 동작하는 코드를 문서 내에 삽입하게 되고 개발자는 그 코드를 가져다가 확인하고 사용합니다. 하지만 코드가 동작하지 않는다면 전체 문서와 제품에 대한 신뢰를 잃어버릴 수 있죠. 그래서 코드를 테스트하는 것이 중요하다고 합니다. https://youtu.be/E9zod8-I-fs 문서 작성 시 개츠비를 사용하는데 개츠비 플러그인 중에서 별도 코드 파일을 마크다운 문서에서 가져와서 사용할 수 있는 플러그인이 있다고 하..
웹팩 한국어 문서는 누가 번역했을까? 오픈소스 프로젝트 중에 한국어로 번역된 문서를 제공하는 프로젝트를 간혹 만날 수 있습니다. 좀 규모가 있는 프로젝트는 국내 사용자 그룹 등이 주축이 되어 번역 프로젝트 팀을 구성하고 번역을 진행합니다. 쿠버네티스 한글화 프로젝트 같은 경우에도 별도 가이드가 잘 만들어져 있고 꽤 많은 인원이 번역에 참여하고 있습니다. https://kubernetes.io/ko/docs/contribute/localization_ko/ 쿠버네티스 문서 한글화 가이드 쿠버네티스 문서 한글화를 위한 가이드 팀 마일스톤 관리 쿠버네티스 문서 한글화팀은 커뮤니티의 현지화 가이드에 따라 한글화를 위한 팀 마일스톤과 개발 브랜치를 관리한다. 본 섹션은 한글 kubernetes.io 오픈소스 문서화는 테크니컬 라이터에게도 권장하는 작..
"지평을 열다"라는 표현의 유래 생각보다 많은 분들이 "지평선을 열다"라는 표현에 관심을 가져주셔서 좀 더 자료를 찾아보았습니다. https://koko8829.tistory.com/2204 "지평선을 열다"는 정말 틀린 표현일까? 지난 11일 윤석열 전 검찰총장이 김대중 도서관을 방문해서 작성한 방명록 때문에 말이 많습니다. 꼼꼼하게 틀린 부분을 지적한 사진도 돌아다니는군요. 하지만 "지평선을 열다"라는 표현은 뭔 koko8829.tistory.com 생각보다 쉽게 찾을 수 있더군요 ㅠㅠ "精選版 日本国語大辞典"라는 일본어 사전에 아래와 같은 해석이 나옵니다. (Horizont の訳語) ドイツの哲学者フッサールの創始した現象学の用語。意識の還元を推し進めてゆく過程において、たえず新しい次元に立たされる主観の前に、くりひろげられる視界。 독일 철학자 ..
"지평선을 열다"는 정말 틀린 표현일까? 지난 11일 윤석열 전 검찰총장이 김대중 도서관을 방문해서 작성한 방명록 때문에 말이 많습니다. 꼼꼼하게 틀린 부분을 지적한 사진도 돌아다니는군요. 하지만 "지평선을 열다"라는 표현은 뭔가 그럴듯해 보여 정말 틀린 표현인지 찾아보았습니다. 일단 6월 이전에 같은 표현을 사용한 사례를 찾아보죠. 영문 사이트에서는 "MADE LIKE NO OTHER, TO RIDE LIKE NO OTHER"라는 표현을 사용하고 있습니다. 한국 측에서 표현을 번역하면서 좀 더 익숙한 표현을 사용하려 했나 봅니다. 어휘력이 부족한 담당자의 실수라고 한다면 이번에는 카이스트로 넘어가 봅니다. 이곳은 좀 더 똑똑한 분들이 많으니깐요. 저 카이스트가 우리가 아는 그 곳 맞겠죠. 이과지만, 국어 실력 또한 남다른 분들이 들어가는 곳입..
API The Docs 2020 - 테크니컬 라이터를 위한 API 교육 New Relic에서 테크니컬 라이터를 위한 외부 초빙 교육을 진행했고 그에 대한 회고 같은 세션입니다. 발표자는 교육을 진행했던 New Relic의 Michelle Fredette와 강사인 Chris Cowell입니다. New Relic은 성능 모니터링을 위한 클라우드 소프트웨어를 개발하는 업체이며 약 2300명이 일하는 기업이라고 합니다. 테크니컬 라이터의 규모는 모르겠지만, 회사 규모가 있는 만큼 테크니컬 라이터가 적지 않을 것으로 보입니다. Chris Cowell는 개발자 경력을 가지고 있으며 지금은 개인 사업자(?)로 기술 배경이 없는 사용자를 위한 교육을 전문적으로 진행한다고 합니다. 1:1 교육도 진행하고 대규모 그룹 강의도 하고요. 개인 강의는 시간당 50달러이고 기업 강의는 1명당 100..
지양해주세요는 무슨 의미일까요? "무엇 무엇을 지양합니다"라는 문장을 읽고 "지양"이라는 표현이 갑자기 낯설게 느껴졌습니다. 그래서 사전을 찾아보았습니다. 국어사전에서 "지양(止揚)"은 "더 높은 단계로 오르기 위하여 어떠한 것을 하지 아니함"이라는 의미를 갖습니다. 그냥 이런 거 하면 안됩니다가 아니라 "더 높은 단계로 오르기 위한"이라는 목적을 담고 있나 봅니다. 아마도 원래 의미는 그러했는지 모르겠지만 요즘에는 "하지마세요"를 좀 유하게 풀어쓰는 것 같은 느낌으로 사용합니다. 예를 들어 상품 판매 시 뭔가 주의를 요하는 내용이 있다면 아래와 같이 적습니다. "예민하신분들은 구매를 지양해주세요" 풀어쓰면 "사지마라"인데 고객에게 그렇게 직설적으로 이야기하기 어려우니 "지양해주세요"라는 표현을 쓰는 듯합니다. 해당 문장을 번역기로 돌..
반응형

티스토리툴바