본문 바로가기

분류 전체보기

(2209)
WTD 프라하 2021 요약 - 히치하이커를 위한 문서화 도구, 프로세스 가이드 Lukas Reussner는 2018년 대학을 졸업하고 Bosch.IO에서 테크니컬 라이터로 일하고 있습니다. 보쉬 자회사로 고객사의 IoT 프로젝트를 지원하는 조직이라고 합니다. 하드웨어 개발부터 비즈니스 모델 설계까지 다양한 분야의 서비스를 제공한다고 합니다. WTD 프라하 2021 첫 세션이었던 이번 발표는 간단한 개념부터 시작해서 QFD(Quality Function Deployment) 기반의 멋진 도구까지 공개해주고 있습니다. 세션 앞부분에서 요구사항의 분류나 문서 도구를 소개할 때까지만 해도 그냥 이렇게 소개만 하면 처음 문서화 작업을 시작하는 이들에게도 아니면 뭔가 현재 프로세스를 바꾸고자 하는 이들에게도 만족스럽지 못할 것 같았는데 QFD 이야기로 넘어가면서 시트에 간단한 체크를 통해 적..
API The Docs 2020 - 제품 관리자와 테크니컬 라이터는 어떻게 같이 일하는가 코로나 시국이라 보통 혼자서 발표하는데 이번 세션은 둘이서 진행을 합니다. 조명이나 배경을 보면 같은 공간은 아니고 각자의 집에서 하는 것 같구요. 그래서 다른 세션보다 살짝 시간이 더 길게 나왔습니다. Onfido는 사진 기반 신원 확인 서비스를 제공하는 기업입니다. Minh Nguyen은 제품 관리자이고 Ben Ahmady는 테크니컬 라이터입니다. Ben Ahmady는 올해 8월 Checkout.com이라는 곳으로 자리를 옮겼네요. 제품 관리자 관점과 테크니컬 라이터 사이의 프로세스에 대해서 설명하는 흔치 않은 세션이긴 합니다. https://pronovix.com/event/api-docs-virtual-2020/ben-ahmady-minh-nguyen Ben Ahmady & Minh Nguyen ..
기간계 시스템은 모두 레거시 시스템인가? 금융 쪽 프로젝트를 해보긴 했지만 살짝 발만 담근 경험이라 그쪽에서 사용하는 용어에 대해서는 잘 모릅니다. 그럼에도 많이 듣게 되는 용어 중 하나가 기간계인데요. 기간계에 대한 설명을 찾아보면 뭔가 이상한 점이 보이는 것들이 있습니다. 그중 하나가 이런 식입니다. 설명을 요약해보면 새로운 솔루션(?)을 도입하기 전에 사용하던 시스템 즉 레거시 시스템이라는 것이죠. 그럼 새로 도입한 솔루션(?)은 기간계가 아닌 다른 용어로 불러야 하겠죠. 하지만 기간계라는 용어를 살펴보면 그런 의미가 아닙니다. 기간계(基幹系)에서 "기간"의 한자어 풀이를 보면 아래와 같습니다. 어떤 조직(組織)이나 체계(體系)를 이룬 것 가운데 중심(中心)이 되는 것. 계정계, 운영계, 정보계, 대외계 등은 연계된 시스템이고 그 중심에 ..
Who made less errors 요즘 미드 실리콘밸리 시즌 5를 보고 있는데, 인상적인 대사가 나와서 기록을 남겨봅니다. 해당 대사는 전반부와 후반부 2번 반복되는데요. 먼저 전반부 대사입니다. Who made less errors. You mean who made "fewer" errors? Oh, you think. you're so clever. 그리고 후반부 대사입니다. What the fuck is going on? Did his code actually have less errors than mine? I don't know what to tell you. I checked it three times. And it's "fewer" errors. 뭔가 프로그래머만 알 수 있는 농담인가 싶었는데 명사의 특성에 대한 이야기입니다..
에멜무지로 - MBC 가나다같이를 보다가 베르나르 베르베르의 개미를 읽으면서 뭔가 단어가 이해가 되지 않았다면 찾아봤을텐데 이건 정말 본 기억이 나지 않습니다. 아마 위의 본문에서는 마키아벨의 이름이 "에멜무지로 마키아벨"이라고 읽은 것이 아닌가 싶습니다. 그렇게 읽어도 내용 상 큰 어색함은 없거든요. 개미를 번역한 이세욱 번역가의 다른 책에서도 "에멜무지로"라는 표현은 자주 등장합니다. 이윤기 번역가도 장미의 이름을 번역하면서 "에멜무지로"라는 표현을 사용하고 있습니다. 이 책 역시 읽은 책인데 TV를 보면서 "에멜무지로"라는 단어를 누가 쓰는거냐라고 생각한 것이 무척이나 부끄럽네요. 사전을 검색해보면 표준국어대사전에서는 "~한 모양"이라고 풀이를 해놓아 명사로 오해할 수 있다고 합니다. "에멜무지로"는 부사라서 고려대한국어사전처럼 설명을 하..
API The Docs 2020 - 소프트웨어 기업이 자신의 이야기를 더 잘 전달하는 방법에 대해 Adam DuVander는 테크니컬 라이터는 아니지만 와이어드에서 프리랜서로 기사를 작성했고 ProgrammableWeb 에디터로도 활동했습니다. 2013년부터 DR(Developer Relation) 쪽 일을 하다가 지금은 EveryDeveloper라는 회사(본인 회사인듯 합니다)에서 컨설턴트로 활동하고 있습니다. 기술 쪽 컨설팅보다는 DR 전담팀이 없거나 시작하는 기업에 가이드를 제공하는 일을 하고 있는 듯 합니다. 그런 활동의 일환으로 API 문서화에도 관심을 가지고 여러 가이드를 제안하는 것이지요. 때문에 이번 세션에 뭐 특별한 이야기가 있는 건 아닙니다. 어떤 식으로 기업에서 개발자들과 정보를 공유하고 이런 정보를 생성하는데 자동화를 적용할 수 있을지 뭐 그런 이야기라고 할 수 있습니다. htt..
케이스 편향? 대충 번역기를 써서 번역하면 대충이라도 알아먹을 수 있는데, 단어 자체가 한국어에서 잘 사용하지 않는 경우에는 번역을 하고 단어의 의미를 알더라도 문장의 의미를 알 수 없습니다. 예를 들어 The classic metric for the success of technical documentation is support case deflection. 라는 문장에서 "case deflection"은 번역기에서는 "사례 편향"으로 번역합니다. "편향"이라는 단어의 의미는 "한쪽으로 치우침", "대전 입자의 비행 방향을 전기장이나 자기장을 가하여 변화시킴"으로 나오는데 case랑 편향이라는 용어를 붙여보아도 의미가 풀리지 않습니다. "case deflection"을 구글에서 검색해보면 여러 설명이 나오는데 고객..
API The Docs 2020 - 문서 내 사용되는 코드 샘플 자동화 Patrick Hammond은 Adyen라는 페이먼트 관련 기업의 프로젝트 매니저입니다. 링크드인 사이트에 가보면 Doc Ops를 담당하고 있다고 본인을 설명하고 있습니다. 영상 중에서도 나오는 표현이긴 합니다. WTD 사이트에서도 https://www.writethedocs.org/guide/doc-ops/ 라는 페이지에서 설명하고 있긴 한데 본인 소개에 사용하는 건 처음 본 것 같습니다. Adyen 같은 경우에는 비슷하지만 조금씩 다른 작은 샘플 코드를 작성하는 것이 이슈였다고 합니다. 그리고 7개 언어를 지원하면서(아마 주석 등에) 실제 작성해야 하는 코드 샘플이 계속 늘어나게 되는 구조입니다. 그래서 코드 샘플을 분석해서 자동으로 언어별 코드 샘플을 생성해주는 프로세스를 개발했다고 합니다. 문서 ..

728x90
반응형