본문 바로가기

테크니컬 라이팅

 (386)
라인에서 테크니컬 라이터는 어떻게 일할까? 지난 3월 일본 라인에서 테크니컬 라이팅 밋업이라는 영상을 공개했습니다. 라이브로 진행된 밋업을 정리해서 유튜브에 공개했더군요. 매달 1회 정도 진행할 예정이라고 합니다. 3월에 공개한 영상은 2개의 세션으로 진행됐는데 첫 번째 세션은 개발자를 위한 글쓰기 팁이고 두 번째 세션은 테크니컬 라이터가 하는 일에 대한 소개입니다. 두 번째 세션에 일본 라인에서 어떤 식으로 일을 하는지 간단하게 소개하고 있어 그 내용을 간략하게 소개합니다. 1. 테크니컬 라이터는 무슨 일을 하나요? 어떤 글을 쓰나요? 주로 하는 일은 외부에 공개되는 개발자 문서를 작성합니다. 예를 들어 라인 로그인 기능을 내 사이트에서 어떻게 구현해야 하는지 알고 싶다면 라인 개발자 사이트에서 관련 가이드와 API 문서를 찾을 수 있습니다. ..
예제와 예시 문서 내에서 예를 들어 설명하는 코드나 이미지를 "예제"라고 써놓았더군요. 예전부터 그렇게 쓰고 있었고 읽었을 때 뭔가 이상한 느낌이 없어서 계속 쓰고 있었는데, 생각해보니 "예제(例題)"는 한자에서 보듯 "보기로 들어주는 연습 문제"라는 의미입니다. 보여지는 코드가 문제 유형이라면 괜찮겠지만 보통은 예시로서 보여주는 것이기 때문에 "예제"는 적합한 표현이 아닌 것 같습니다. "예시(例示)"가 좀 더 적절한 표현이겠네요. 영어 사전만 봐도 "예제"는 "exercise, practice problem"이고 "예시"는 "example, illustration"입니다. 보통 문서 내에서는 "Example"의 의미로 사용하기 때문에 "예시"가 맞겠죠. 그냥 "예"라고 표현해도 되고요.
NHN 테크니컬 라이터가 추천하는 테크니컬 라이터를 위한 참고 도서 (1) '개발자를 위한 글쓰기 가이드 / 유영경 / 로드북'에서 참고자료(도서) 목록을 정리했습니다. 이번 글에서는 번역서 또는 국내서를 먼저 소개합니다. 1. 바바라 민토, 논리의 기술 국내에서는 2005년, 2019년 두 차례 출판됐습니다. 국내에 나온 책은 1996년판을 바탕으로 번역했다고 하는데 원서 최신판은 2010년판입니다. www.barbaraminto.com/textbook.html 사이트를 보면 기존 책(The Pyramid Principle: Logic in Writing and Thinking)을 새로운 책(The Minto Pyramid Principle: Logic in Writing, Thinking and Problem Solving)이 대체한다고 명시되어 있는데 뭔가 저작권 관련 분..
차출과 착출 한 줄 요약"차출"과 "착출"은 같은 의미는 아닙니다. 하지만 "착출"이 없는 단어도 아닙니다. 메신저로 대화를 하다가 "착출 되었답니다"라는 표현을 쓰고 나서 뭔가 느낌이 이상해서 사전을 찾아보니 "착출"이라는 단어는 없고 "차출"이 맞는 표현이라고 합니다. 다행스럽게도 신문기사에서도 "착출"이라는 표현을 간혹 쓰는 걸 보면 많이 틀리는 표현인가 봅니다. 그런데 국립국어원 답변이 좀 애매합니다. 착출이 맞는지 물어보는 질문에 한자 표현일 수도 있다는 답변을 남기더군요. 보통 오타라고 판단되면 "차출의 오타입니다"라는 식으로 답변을 달아주는데 말이죠.  그래서 찾아보았습니다. 국어사전뿐 아니라 한자사전에서도 "착출"은 보이지 않습니다. 일본어 사전에는 표현이 있긴 한데, 좀 다른 의미인 듯하네요. 하지만..
구문(構文) 'syntax'를 '구문'으로 번역하는 것이 뭔가 어색하다는 느낌이 들어서 그 의미를 찾아보았습니다. 그러고 보니 아무 의심 없이 '구문'이라는 표현을 사용하고 있었더라구요. 네이버 국어사전 (표준국어대사전) 2가지 의미를 보여줍니다. 일반적인 글에서 사용하는 의미와 컴퓨터 분야에 해당하는 의미가 따로 설명되고 있습니다. - 글의 짜임. - 컴퓨터에서, 원시 언어의 문장을 올바르게 구성하기 위한 규칙. 자연어의 문법에 해당한다. 두 번째 설명이 좀 애매하네요. '자연어의 문법에 해당한다'라니요. 근데 왜 문법이 아니라 구문이라고 하는 거죠. 정보통신용어사전 3가지 의미를 보여줍니다. 뭐 그렇지만 해석의 차이일 뿐 내용은 크게 다르지 않습니다. - 문자들의 의미 해석을 하고 사용하는 방법과는 무관한 문자들..
'docusaurus' is not recognized as an internal or external command 에러 뭐 여러가지 상황이 있겠지만, 저 같은 경우는 아래와 같은 문제였습니다. 3월 둘째주에 사이트를 만들고 3월 셋째주에 라이브에디터 플러그인을 설치하고 개발서버를 실행하려 할 때 에러가 발생했습니다. 상황을 보면 그 사이에 2.0.0-alpha.71 버전에서 2.0.0-alpha.72 버전으로 업데이트가 됐습니다. 그 과정에서 참조하는 코드 일부가 꼬였고, 실행이 안된 모양입니다. 새로 사이트를 만들고 실행을 하니 정상적으로 실행이 됩니다. 둘째주에 설치한 package.json 파일은 아래와 같습니다. 라이브 코드 플러그인은 72 버전인데, 버전이 맞지 않아 오류가 난 것입니다. 그럼 새로운 버전으로 업데이트했으니 정상적으로 실행이 되어야 하는데 아래와 같은 에러가 나면서 콘텐츠 업데이트가 되지 않습니다..
도큐사우르스 V2가 나왔네요 음. 언제 나온거지...(2019년 중반에 나왔다고 합니다). 이전 이력을 찾아보니 2018년에 V1 문서 번역을 일부 진행했었는데, V2가 나오면서 V1 번역 프로젝트는 종료가 되었군요. * 아. 아직 알파버전입니다. 자기네 말로는 안정적인 알파버전이라고 하는데~ 그게 뭔지~ 뭐 이런 저런 사정이 있었겠지만, 다른 언어도 100% 완결이 되지는 못했습니다 ^^ 그래도 V1 문서에 일부 한국어 번역이 반영되어 기본 가이드 정도는 제공했다고 생각되네요. docusaurus.io/docs/ko/translation Docusaurus · Easy to Maintain Open Source Documentation Websites Easy to Maintain Open Source Documentation W..
projectcartoon.com 사이트 연결이 안됩니다 아마도 한 번 정도는 보았을 그림입니다. 구전으로 전해져내려오는 이야기를 누군가 꽤 깔끔한 카툰으로 만들었고, 텍스트를 수정해서 나만의 카툰을 만드는 기능도 제공했었습니다. 지금은 연결이 안됩니다 해당 사이트를 지금 들어가보면 Justin Hourigan 이라는 개발자 프로필 사이트로 연결됩니다. 히스토리를 찾아보니 2019년 12월까지는 사이트가 살아있었고 2020년 1월 들어오면서 사이트 연결이 안되더니 2020년 5월 즈음에 Justin Hourigan 이라는 개발자가 해당 도메인을 자신의 프로필로 연결한 듯 합니다. 그래서 다들 출처를 표기하지만 해당 출처는 더 이상 유지되지 않는다는.... 정확한 제목은 'How Projects Really Work (version 1.5)'였네요. web.ar..
반응형

티스토리툴바