테크니컬 라이팅/WTD 컨퍼런스 (141) 썸네일형 리스트형 WTD 애틀랜틱 2024 - 사용자 온보딩을 테크니컬 라이터가 주도하기 이번 세션에서 설명하는 온보딩은 신규 입사자가 아니라 고객 대상입니다 고객이 새로운 제품에 안정적으로 안착하고 그들의 목표를 달성할 수 있게 도와주는 과정에 대한 이야기입니다. 온보딩을 설명하는 단계는 여러 가지가 있지만 조직에 따라 적절하게 어느 단계에 들어가서(승차) 어느 단계에 나와야 하는지(하차) 명확하게 알아야 합니다. 온보딩은 실제 회사의 수익과 연결이 되는데 테크니컬 라이터가 잘할 수 있는 점을 활용해서 온보딩 프로세스의 주도권을 가지게 되면 테크니컬 라이터가 단지 제품의 부가적인 지원이 아니라 핵심적인 수익이 될 수 있습니다(최근 커뮤니티에 테크니컬 라이터 Role이 사라져서 일자리를 잃었다는 소식이 많은데 대부분 그들의 일이 회사의 수익과 연결된다는 것을 증명하지 못해서 그런 것일 수 있.. WTD 애틀랜틱 2024 - 아랍어 현지화 경험에 대한 이야기 오픈소스는 새로운 시장으로 진출해야 하기 때문에 다른 어떤 소프트웨어보다도 현지화가 중요합니다. 현지화가 되어 있지 않으면 선택받을 가능성이 줄어들기 때문이죠. 쿠버네티스에 대한 현지화 작업은 이전에도 몇 차례 시도가 되었지만 다들 지속적인 활동으로 이어지지 못했습니다. 그러다가 올해 초 SIG-Docs 현지화 서브그룹 리더인 손석호 님이 주도해서 커뮤니티를 하나로 묶어주었습니다. 손석호 님은 ETRI 전문위원으로 다양한 오픈소스 커뮤니티에 참여하고 있고 한글화 팀을 리드하는 분이기도 합니다. 현지화 작업은 단순히 번역만 하는 것이 아니라 다양한 스태프의 참여가 필요하기 때문에 커뮤니티를 리딩하는 누군가가 필요하고 다양한 기여자가 필요합니다. 참고: SIG Docs 및 한글화 기여를 통해 쿠버네티스에 .. 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/.. WTD 애틀랜틱 2024 - 누구나, 어디서든 사용할 수 있는 콘텐츠 디자인 발표자의 배우자가 코로나 기간 동안 산책을 나갔다가 개의 습격을 받아 머리의 손상을 입었다고 합니다. 이후 과정에서 활동을 지원해 주는 다양한 도구들을 찾아보면서 접근성에 대해 고민하기 시작했다고 하네요. 접근성에 대한 기본 개념에 대한 설명을 9분까지 진행합니다. 접근성에 대해 어느 정도 알고 있다면 9분 이후부터 시청해도 될 듯합니다. 영상이 발표보다는 홍보 영상 같은 느낌이라서 살짝 이질감이 있긴 합니다. 너무 잘 만든 영상이 주는 부작용이랄까요. 9분 이후부터는 발표자가 속한 기업에서 콘텐츠의 접근성을 검토하면서 어떤 활동을 했는지 설명하고 있습니다. accessScan이라는 유료 서비스를 통해 현재 제공되는 콘텐츠의 접근성을 검토했다고 합니다. 보통은 무료 도구를 사용하는데 전반적인 접근성을 향.. WTD 애틀랜틱 2024 - 문서와 대화하는 방식의 변화 LLM의 간략한 역사와 현재 LLM의 제약(제한된 학습 데이터, 환각 현상)을 설명합니다. 이를 보완하기 위한 수단으로 RAG를 설명합니다. RAG는 2가지 타입이 있습니다. 하나는 벡터 기반 RAG입니다. 유사성 검색을 지원하고 매우 빠르게 동작합니다. 그리고 대규모 문서도 잘 처리할 수 있습니다. 하지만 개념들의 관계를 놓칠 수 있습니다. 특히 긴 문서에서 전체적인 맥락을 잘못 이해할 수 있습니다. 그래서 벡타 기반 RAG를 사용하기 위해서는 문서에 대한 전처리 과정이 중요합니다.또 하나는 그래프 기반 RAG입니다. 지식 그래프와 LLM을 결합해서 벡터 기반 RAG를 보완하는 방식입니다. 벡터 기반 RAG의 단점인 개념 간의 관계를 정의하고 있기 때문에 이를 명확하게 설명할 수 있습니다. 단점은 일단.. WTD 애틀랜틱 2024 - 문서 템플릿의 역사 수잔 암스트롱 링크드인 경력을 보면 1986년부터 테크니컬 라이팅 업무를 시작했습니다. 소프트웨어, 장비, 네트워크 등 다양한 분야를 경험했습니다. 2013년부터는 기술 문서 관련 컨설팅 업무를 수행하고 있다고 합니다. 컴퓨터와 온라인이 등장하기 전에는 대부분 매뉴얼이 일정한 템플릿에 따라 작성됐습니다. 어떤 기술 문서를 보든 어떤 순서로 따라 할 수 있는지 직관적으로 이해할 수 있습니다. 또한 특정 작업을 바로 수행해야 할 때도 있어서 개별적인 과업에 대한 문서도 템플릿에 따라 작성이 되었습니다. 하지만 너무 형식적인 템플릿 때문에 실제 과업을 수행하는데 어려움을 겪었습니다. 1980년대 IBM 등에서 기술 문서에는 필수 정보를 담아야 한다는 미니멀리즘이 언급되었고 이런 경향은 최근까지 이어져오고 있.. WTD 애틀랜틱 2024 - 아직도 워드에서 문서를 작성하고 있나요? Lorna Mitchell은 Redocly에서 테크니컬 라이터로 일하고 있습니다. 소프트웨어 개발자 경험이 있고 기술 서적을 출판한 경험이 있습니다. 이번 강연은 어떻게 보면 낯선 환경에 들어서야 하는 테크니컬 라이터를 위한 강연인데.... 너무 원칙적인 이야기하면 해서 그럼 어떻게 해야하는데라는 질문이 나올 수밖에 없네요. Q&A에서도 언급되었지만, 그건 각자 알아서 공부하라는... DevOps의 간략한 정의 - Dev: 소스 컨트롤, 코드 개발 도구 - Ops: 빠른 피드백, 지속적인 개선 이 강연에서 배운 것을 활용하기 위한 전제 조건 - 기술 문서는 텍스트 기반으로 작성되어야 합니다(예를 들어 마크다운 같은. 텍스트 기반 콘텐츠의 장점은 서식을 설정하거나 맞춤법 검사 등 도구와 연결하는데 매우 .. 이전 1 2 3 4 5 6 ··· 18 다음
