테크니컬 라이팅/컨퍼런스 (175) 썸네일형 리스트형 AI The Docs 2024 - LLM의 등장이 OpenAPI 진영에 미치는 영향 발표자인 Marsh Gardiner는 OpenAPI 프로젝트에 초기부터 참여했고, 지금도 보드 멤버로 참여하고 있다고 합니다. 2009년부터 Apigee에 근무하다가 2016년 구글에 인수되면서 구글에서 PM으로 2023년까지 일했습니다. LLM의 등장이 API 진영에 미치는 영향 중 하나는 사용자의 범위가 확대된다는 것입니다. 기존에는 전문적인 개발자를 대상으로 서비스를 제공하고 정보를 전달했다면 이제는 프로그래밍을 전혀 모르는 사용자가 LLM을 통해 API 사용을 시도할 수 있다는 것입니다.그래서 API 제품 사용 여정을 다시 설계하고 고민할 필요가 있습니다. 이와 관련해서 OpenAPI에서는 2025년 문워크 SIG(OpenAPI 4.0)를 조직하고 운영하고 있습니다. 아직 출시 일정은 정해지지 않.. AI The Docs 2024 - 대규모 문서를 LLM으로 다루는 방식 커피 전문점(스타벅스 같은)에서는 커피를 커스텀하게 만드는 방법이 17만 가지라고 합니다. 예를 들어 온도를 10의 점수로 부여하고 커피의 진하기를 10의 점수로 부여한다면 벌써 100가지 조합이 가능하죠. 그런 식으로 수십 가지의 측정할 수 있는 항목이 있고 그 조합이 17만 가지라고 합니다. 이런 커피 스토리를 가지고 LLM, RAG가 어떻게 동작하는지를 쉽게 설명해주고 있습니다. 머신 러닝 시절에는 기계한테 커피 만드는 방법을 학습시키는 방식으로 몇 가지의 커피를 만드는 방법을 배우게 하는 것이라면 LLM은 온갖 커피 레시피 관련 정보를 스스로 탐색하고 정리해서 수백 개의 커피 레시피를 만들고 변형시킬 수 있다는 점입니다. 그리고 실제적인 사용 사례로 시맨틱 검색으로 들어가는데, 여기부터는 갑자기 .. AI The Docs 2024 - APIs.json으로 AI 에이전트가 좀 더 쉽게 정보를 이해하게 만들기 AI 에이전트가 API 문서를 이해하기 위해 단순히 OpenAPI, AsyncAPI 같은 API 명세만으로는 충분하지 않으며, API를 제대로 이해하고 활용하려면 전체 API 운영 정보를 기계가 읽을 수 있는 형태로 제공해야 한다고 강조합니다. 이런 정보를 제공할 수 있는 적절한 방법이 APIs.json이라고 합니다. APIs.json은 문서, 인증, 버전, 가이드 뿐 아니라 가격 정보까지 API 전반에 걸친 정보를 구조화해서 담을 수 있으며 확장할 수 있기 때문에 AI 에이전트가 적절하게 정보를 탐색할 수 있는 안내를 제공할 수 있다고 합니다. 웹사이트에서 sitemap.xml 파일을 SEO를 위해 활용한 것과 비슷한 개념이라고 할 수 있습니다. https://apisjson.org/https://.. WTD 포틀랜드 2025 - 라이트닝 토크 모음 (2) Jennifer Evans: But did you die? Doing things scared두렵고 무서운 일이라도 시도했을 때 죽지 않는다. 그러니 괜찮다. 그런 격려의 메시지입니다. Michelle Knight: Document: your most valuable data asset메시지가 좀 모호하긴 한데, 조직 내에서 기술 문서도 데이터 자산으로 관리되어야 하고 이에 대한 거버넌스 체계가 필요하다는 이야기입니다.전통적인 데이터 거버넌스 범위는 실제 데이터에 초점을 맞추고 있지만, 최근에는 문서 역시 대상이 될 수 있다고 합니다. 좀 더 상세한 내용은 어떤 식으로 관리한다는 것인가를 찾아봐야 할 텐데, 그런 자료는 찾기가 쉽지 않네요. Ashley Gordon: I Come Back Stronger.. WTD 포틀랜드 2025 - 라이트닝 토크 모음 (1) Zaz Linkous: Game design in documentation 게임을 만들 때 마리오 1.1 이라는 것이 있다고 합니다(검색해 보면 World 1-1이라고 나옵니다). 게임을 시작할 때 안전한 환경에서 게임 조작법을 익히는 레벨입니다. 게임 디자인의 교과서 같은 것이라고 하네요. https://en.wikipedia.org/wiki/World_1-1하지만, 기술 문서에서는 World1-1같은 안전한 공간이 없습니다. 처음부터 혼돈의 세계에 던져지는 상황이 많죠. 때문에 게임 디자인의 원칙을 공부하면 좀 더 사용자가 안전한 환경에서 제품에 접근하도록 가이드할 수 있습니다(실제 클라우드 서비스 같은 경우에는 동작을 배우기 위해 비용이 들어가는데, 튜토리얼 같은 문서에서는 별도의 비용 없이 따라 .. WTD 포틀랜드 2025 - 커뮤니티와 같이 문서 만들기 Discord의 시니어 개발자 에반젤리스트 Colin Loretz가 문서를 누구나 기여할 수 있도록 '오픈'하고, 커뮤니티와 PR 중심으로 협업하며 얻은 교훈과 실질적 운영 노하우를 공유합니다. Discord는 오픈소스 제품은 아니지만, 문서는 공개된 GitHub 저장소에서 관리하며, 매달 30~50건의 PR 중 절반 이상이 커뮤니티에서 올라올 만큼 활발한 협업이 이루어지고 있습니다.https://github.com/discord/discord-api-docs 1. 오픈 문서의 의미와 효과 - 문서를 오픈하면 개발팀과 사용자와의 '공동 창작' 및 '공동 소유' 관계가 형성됩니다. - Discord는 공식 SDK 외에도 60개 이상의 커뮤니티 라이브러리(20개 이상 언어)를 지원하며, 이 생태계가 문서에 .. WTD 포틀랜드 2025 - 경쟁 분석을 통해 기술 문서 개선하기 이 발표에서 Leah Catania(Insulet의 시니어 콘텐츠 전략가)는 테크니컬 라이터와 콘텐츠 전략가가 "경쟁사 분석(Competitive Analysis)"을 활용해 문서 전략을 개선하고, 이해관계자(stakeholder)의 신뢰와 동의를 얻는 실질적인 방법을 공유합니다. 실제 경험과 구체적인 사례를 바탕으로, 경쟁사 분석의 준비, 실행, 결과 활용, 설득 전략까지 단계별로 설명합니다.(간혹, 실제 업무는 테크니컬 라이터인데 콘텐츠 전략가라고 소개하는 경우도 있는데, Insulet의 경우에는 테크니컬 라이터, UX 테크니컬 라이터, 콘텐츠 전략가 이런 식으로 상당히 세분화되어 팀을 구성하고 있습니다. 의료기기를 다루는 업체 특성인 것 같기도 합니다).1. 경쟁사 분석이란 무엇인가? 경쟁사 분석은.. WTD 포틀랜드 2025 - 조직 규모에 따라 테크니컬 라이터가 하는 일이 달라지나요 발표자는 현재 회사(Klaviyo)에 2019년 합류했는데 그 시점에 전체 구성원은 350명 정도였고 테크니컬 라이터는 3명이었다고 합니다. 이때는 스타트업 규모였고 테크니컬 라이터의 역할은 기술 문서뿐 아니라 온보딩, 마케팅, 블로그 관리 등 여러 가지 필요한 일들을 다 했어야 했습니다. 이 시기에 만든 콘텐츠 중에 사용자들이 주로 겪는 사례들을 FAQ 형태로 만든 콘텐츠가 300여개300여 개 정도 있었습니다. 하지만 여러 가지 일을 해야 하는 3명의 테크니컬 라이터에게는 관리하기 어려운 짐이 되어버렸습니다. 그런데 마침 외부 개발자 커뮤니티를 만드는 팀이 있었는데 그 팀에는 부족한 콘텐츠가 문제였습니다. 우리가 가지고 있는 300여 개의 부담스러운 콘텐츠는 그들에게 커뮤니티 게시물을 늘릴 수 있는 .. 이전 1 2 3 4 5 6 ··· 22 다음
