전체 글 (2495) 썸네일형 리스트형 WTD 애틀랜틱 2024 - GraphQL 문서를 좀 더 풍성하게 만들기 GraphQL을 사용하면 Introspection을 활용하면 API 문서를 자동으로 생성할 수 있습니다. 하지만 기본 제공되는 문서화 기능만으로는 독자가 맥락을 파악하고 손쉽게 원하는 정보를 얻을 수 없습니다. 때문에 다양한 도구를 사용해서 독자가 정보를 탐색할 수 있게 합니다. 테크니컬 라이터가 별도의 기술 지원을 받지 않고도 GraphQL Playground나 GraphiQL 같은 것을 사용해 기본 문서에 인터랙티브한 기능을 더하고 독자들에게 필요한 정보를 제공할 수 있습니다. 모범적인 사례로 shopify를 보여줍니다(아마 shopify는 자체 개발을 통해 기능을 구현한 것으로 보입니다. 뒤에서 설명하는 발표자의 highnote 사례와는 좀 다릅니다). shopify의 경우 API를 한 페이지에 .. WTD 애틀랜틱 2024 - 코드 기반 다이어그램 사용하기 kong 문서 팀은 6명으로 구성되어 있습디다. 5명의 테크니컬 라이터와 1명의 도큐먼트 엔지니어가 일하고 있습니다. 이 팀에서 13명의 PM과 150여명의 개발 엔지니어. 30여명의 지원 엔지니어와 함께 문서화 작업을 진행합니다. 문서 팀에서 다루어야 할 업무가 점점 많아지고 있어서 가능한 반복적인 작업은 자동화할 수 있도록 노력하고 있습니다. 그 중 하나가 다이어그램이었습니다. 다이어그램을 위해 사용하는 프로그램은 한 가지가 아니었습니다. Figma, Miro, Lucidchart, draw.io 같은 도구를 사용하고 있었습니다. 그리고 그 외에 다른 도구를 사용하기도 했습니다. https://www.figma.com/resource-library/diagramming/https://miro.com/.. 2024년 11월 테크니컬 라이팅 이런 저런 소식 11월 5일UX 라이터 커리어 패스, 어떤 것들이 있을까요? https://capturephrase.stibee.com/p/96/캡처프레이즈는 매주 금요일 아침 UX 라이팅 해외 아티클을 번역하는 서비스라고 합니다. 번역한 원문은 Joshua Gene Fechter가 작년 11월에 작성한 글인데 Technical Writer HQ라는 서비스를 창업한 분이기도 합니다. 테크니컬 라이팅 관련 자격증 코스를 운영하고 다양한 테크니컬 라이터와의 인터뷰를 게시하는 곳이기도 하죠. 눈치채셨겠지만 역시 약간은 마케팅 성격이 강한 글입니다. What is the Technical Writer Career Path? 라는 글도 같이 보시면 좋겠네요. https://www.linkedin.com/pulse/what-tec.. WTD 애틀랜틱 2024 - 누구나, 어디서든 사용할 수 있는 콘텐츠 디자인 발표자의 배우자가 코로나 기간 동안 산책을 나갔다가 개의 습격을 받아 머리의 손상을 입었다고 합니다. 이후 과정에서 활동을 지원해 주는 다양한 도구들을 찾아보면서 접근성에 대해 고민하기 시작했다고 하네요. 접근성에 대한 기본 개념에 대한 설명을 9분까지 진행합니다. 접근성에 대해 어느 정도 알고 있다면 9분 이후부터 시청해도 될 듯합니다. 영상이 발표보다는 홍보 영상 같은 느낌이라서 살짝 이질감이 있긴 합니다. 너무 잘 만든 영상이 주는 부작용이랄까요. 9분 이후부터는 발표자가 속한 기업에서 콘텐츠의 접근성을 검토하면서 어떤 활동을 했는지 설명하고 있습니다. accessScan이라는 유료 서비스를 통해 현재 제공되는 콘텐츠의 접근성을 검토했다고 합니다. 보통은 무료 도구를 사용하는데 전반적인 접근성을 향.. TCN meetup 2024.10 후기 - LINE과 Yahoo의 사내 용어집 Words 이야기 발표 목차가 인상적이네요. - Words 소개 (첫 시작, 현재) 김지현 님은 일본어를 전공하고 번역 업무로 시작해서 네이버, 라인을 거치면서 자연스럽게 테크니컬 라이터 업무를 같이 하게 되었다고 합니다(일반적인 테크니컬 라이터 커리어이긴 합니다). 번역 업무를 시작할 때도 가장 먼저 시작했던 일이 관련 업무에 대한 용어를 익히는 일이었습니다. 낯선 세계에 적응할 수 있는 가장 빠른 방법이 용어를 익히는 것이라고 생각했다고 하네요. Words를 만든 궁극적인 목표는 구성원 간의 원활한 소통을 위한 것이라고 합니다. 그래서 함께 만드는 사내 용어집이라는 슬로건을 사용하고 있구요. 프로젝트는 2021년 OKR 회의에서 도출이 되어 시작되었고 코로나 시기 재택 업무를 하면서 신입 사원들이 새로운 환경에 적.. WTD 애틀랜틱 2024 - 문서와 대화하는 방식의 변화 LLM의 간략한 역사와 현재 LLM의 제약(제한된 학습 데이터, 환각 현상)을 설명합니다. 이를 보완하기 위한 수단으로 RAG를 설명합니다. RAG는 2가지 타입이 있습니다. 하나는 벡터 기반 RAG입니다. 유사성 검색을 지원하고 매우 빠르게 동작합니다. 그리고 대규모 문서도 잘 처리할 수 있습니다. 하지만 개념들의 관계를 놓칠 수 있습니다. 특히 긴 문서에서 전체적인 맥락을 잘못 이해할 수 있습니다. 그래서 벡타 기반 RAG를 사용하기 위해서는 문서에 대한 전처리 과정이 중요합니다.또 하나는 그래프 기반 RAG입니다. 지식 그래프와 LLM을 결합해서 벡터 기반 RAG를 보완하는 방식입니다. 벡터 기반 RAG의 단점인 개념 간의 관계를 정의하고 있기 때문에 이를 명확하게 설명할 수 있습니다. 단점은 일단.. 스포티파이 무료 계정에서 들을 수 없는 앨범 스포티파이 무료 계정이 공식적으로 10월 16일 공개됐습니다(물론 얼마 전부터 슬슬 간을 보기 시작한 것 같긴 합니다만).언론사에 보도 자료를 배포하고 무료 계정 서비스를 알리고 있습니다.https://n.news.naver.com/mnews/article/421/0007846659?sid=105 ...스포티파이는 한국음악저작권협회와 계약을 맺고 이달 10일 무료 음원 스트리밍 멤버십 '스포티파이 프리'(Spotify Free)를 국내에 출시했다고 16일 밝혔다... 아마 무료 서비스를 제공하기 위한 저작권 문제가 어느 정도 해결이 되었나 봅니다. 다만 일부 앨범은 무료 계정에서 들을 수가 없습니다. 무료 계정 서비스를 시작하면서 제한을 두기 시작한 것인지는 모르겠으나 개인적으로 라이브러리에 넣어두고 즐.. WTD 애틀랜틱 2024 - 문서 템플릿의 역사 수잔 암스트롱 링크드인 경력을 보면 1986년부터 테크니컬 라이팅 업무를 시작했습니다. 소프트웨어, 장비, 네트워크 등 다양한 분야를 경험했습니다. 2013년부터는 기술 문서 관련 컨설팅 업무를 수행하고 있다고 합니다. 컴퓨터와 온라인이 등장하기 전에는 대부분 매뉴얼이 일정한 템플릿에 따라 작성됐습니다. 어떤 기술 문서를 보든 어떤 순서로 따라 할 수 있는지 직관적으로 이해할 수 있습니다. 또한 특정 작업을 바로 수행해야 할 때도 있어서 개별적인 과업에 대한 문서도 템플릿에 따라 작성이 되었습니다. 하지만 너무 형식적인 템플릿 때문에 실제 과업을 수행하는데 어려움을 겪었습니다. 1980년대 IBM 등에서 기술 문서에는 필수 정보를 담아야 한다는 미니멀리즘이 언급되었고 이런 경향은 최근까지 이어져오고 있.. 이전 1 2 3 4 ··· 312 다음
