본문 바로가기

분류 전체보기

 (2540)
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개 언어를 지원하면서(아마 주석 등에) 실제 작성해야 하는 코드 샘플이 계속 늘어나게 되는 구조입니다. 그래서 코드 샘플을 분석해서 자동으로 언어별 코드 샘플을 생성해주는 프로세스를 개발했다고 합니다. 문서 ..
API The Docs 2020 - API와 개발자 경험 Lorna Mitchell은 통신 서비스를 제공하는 보네이지(Vonage)의 DR팀 담당자입니다. 좋은 API라도 문서가 없다면 개발자들이 이를 사용하는데 어려움을 겪는다는 이야기입니다. 좋은 API 문서 또는 환경을 만들기 위해 어떤 것이 필요한지 설명하고 있습니다. 개발자들이 문서나 기능을 살펴볼 때 모든 항목을 한 번에 보지는 않습니다. 발표자는 이런 모습을 식당에서 메뉴판을 보고 주문하는 것이 비유했는데요. 특별한 경우가 아니면 모든 메뉴를 주문하지는 않는 모습과 비슷하다고 합니다. 때문에 문서를 만들 때는 적절한 분류를 통해 개발자가 원하는 항목을 선택할 수 있도록 해야 합니다. 메뉴판에 기재된 문서(음식)은 부족함이 없어야 합니다(마치 식당에 갔는데 메뉴마다 너무 편차가 심한 경우에는 좋은 식..
Guardian Typerighter 개발 스토리 "How we made Typerighter, the Guardian’s style guide checker"라는 글에 대한 요약정리입니다. 원문은 아래 링크를 참고하세요. https://www.theguardian.com/info/2021/jan/26/how-we-made-typerighter-the-guardians-style-guide-checker How we made Typerighter, the Guardian’s style guide checker Lots of regular expressions, and a timely demonstration by an editorial colleague, led to a two year side-project that eventually ended up..
API The Docs 2020 - API 문서 최적화 발표자인 Michael Meng은 테크니컬 라이터 경력을 가지고 있으며 지금은 Merseburg University의 교수로 일하고 있습니다. https://www.hs-merseburg.de/hochschule/information/personenverzeichnis/details/person/meng-michael-370/ Details Tätigkeitsbereiche Textanalyse und Textproduktion Technische Dokumentation Usability und Forschungsmethoden www.hs-merseburg.de 이번 발표는 SIGDOC 컨퍼런스에서 발표한 논문에 대한 이야기입니다. 논문 내용을 그대로 설명한 것은 아니고 어느 정도 컨퍼런스 주제에 맞..
모밀꽃 필 무렵은 왜 메밀꽃 필 무렵이 되었을까? 페북에서 "메밀꽃 필 무렵"이 원래는 "모밀꽃"이었다는 이야기를 보고 갑자기 궁금해졌습니다. 관련해서 여러 글이 있지만 논문 형식으로 작성된 것은 "이재춘 (1998). 문학작품 원본의 오류와 변개 양상-이효석의 모밀꽃 필 무렵을 중심으로. 우리말글, 407-429"라는 글이 있더군요. 해당 논문에서 이야기하는 것은 이 작품의 문제 뿐 아니라 30년대 이전 또는 방언을 사용한 작품이 교과서 등에 실리면서 현대국어로 변형하는 과정에서 작가의 의도를 해치는 문제가 많다는 것입니다. 소설보다는 시에서 그런 면이 더 강하게 나타나고 있구요. "메밀꽃 필 무렵"의 경우는 그런 문제도 있지만 원본 자체가 가지고 있는 오류를 잘못 해석해서 판본에 따라 전혀 다른 이야기로 바꾸어버리는 일도 있다고 합니다. (조광, 1..
NHN 테크니컬 라이터가 추천하는 테크니컬 라이터를 위한 참고 도서 (2) '개발자를 위한 글쓰기 가이드 / 유영경 / 로드북'에서 참고자료(도서) 목록을 정리했습니다. 이번 글에서는 번역되지 않는 책을 소개합니다. 1. Technical Writing 101 제목처럼 테크니컬 라이팅의 기본적인 원리와 방법을 안내합니다. books.google.co.kr/books?id=fKwZAgAAQBAJ Technical Writing One Hundred One 서평을 찾을 수 없습니다. books.google.co.jp 2. Technical Editing 문서 편집자 관점에서 프로젝트를 설계하고 테크니컬 라이터와 어떻게 협업을 진행할 것인지부터 시작해서 문서 배포를 위한 도구, 문서 편집에 대한 내용을 다룹니다. books.google.co.kr/books?id=BuZgSQAACAA..
반응형

티스토리툴바