본문 바로가기

테크니컬 라이팅

 (440)
AI The Docs 2024 - 개발자 포털은 이제 최소한의 기준선입니다 개발자 포털은 2000년대 초반 구글이나 세일즈 포스 같은 회사에서 API 서비스가 제공되면서 등장했고, 2010년이 넘어가면서 좀 더 많은 회사들이 API 서비스를 제공하면서 개발자 포털을 구축하는 것이 유행처럼 번졌습니다. 개발자 포털은 단순히 문서를 제공하는 것을 넘어 서비스를 수행하는 방법을 좀 더 쉽게 이해할 수 있도록 안내하고 개발자 포털을 통해 회사는 서비스 비용을 줄일 수 있었습니다. 현재 시점에서 개발자 포털은 "Table Stake"입니다(테이블 스테이크는 경제 용어로 시장에 대한 "최소 진입 요건"이라고 하네요. 참고로 Table Stake는 포커 등의 도박에서 최소한의 판돈을 의미한다고 합니다. 고기 스테이크(steak)와는 철자가 다르군요). API 서비스를 제공한다면 기본적으로 ..
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은 온갖 커피 레시피 관련 정보를 스스로 탐색하고 정리해서 수백 개의 커피 레시피를 만들고 변형시킬 수 있다는 점입니다. 그리고 실제적인 사용 사례로 시맨틱 검색으로 들어가는데, 여기부터는 갑자기 ..
2025년 8월 테크니컬 라이팅 이런 저런 소식 8월 1일매뉴얼웍스 with AIhttps://www.3rabbitz.com/book_release_note_ko/6_0_7https://www.3rabbitz.com/manual-works-with-ai국내에서 매뉴얼 제작 도구 매뉴얼웍스를 만드는 쓰리래빗츠에서 AI 기능을 도입했다는 소식입니다.정확하게는 Claude, Gemini, Grok, Ollama, OpenAI, Voyage AI에서 제공하는 API를 사용할 수 있는 서비스(챗봇, AI 글쓰기, AI 맞춤법 검사와 교정, AI 아이콘 추천)를 제공하는 것입니다.API 이용에 따른 절차와 비용은 사용자가 부담하는 것이고 매뉴얼웍스에서는 API를 활용할 수 있는 인터페이스와 부가적인 기능을 제공하는 것이겠죠. 챗봇 기능은 쓰리래빗츠 홈페이지에 적..
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://..
2025년 7월 테크니컬 라이팅 이런 저런 소식 7월 7일Docusaurus를 이용한 API 문서 플랫폼의 진화https://d2.naver.com/helloworld/6196427네이버 사내 기술 교류 행사인 NAVER ENGINEERING DAY 2025(5월)에서 발표되었던 세션이라고 합니다. 그래서 문서의 작성보다는 기술적으로 기존 문서화 플랫폼(Redoc)에서 새로운 플랫폼(Docusaurus)으로 전환하는 과정, 검색 기능(typesense)을 추가하는 과정, 버전에 따른 안정적이 배포 방식(Nubes) 등을 설명합니다.기존에는 Redoc 커뮤니티 버전을 사용하고 있었는데, 버그도 많고 앞으로 추가하려는 기능 제약, 성능 이슈 등의 문제로 좀 더 컨트롤이 가능한 오픈소스 문서화 플랫폼을 찾았고, Docusaurus를 선택했다고 합니다. * ..
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같은 안전한 공간이 없습니다. 처음부터 혼돈의 세계에 던져지는 상황이 많죠. 때문에 게임 디자인의 원칙을 공부하면 좀 더 사용자가 안전한 환경에서 제품에 접근하도록 가이드할 수 있습니다(실제 클라우드 서비스 같은 경우에는 동작을 배우기 위해 비용이 들어가는데, 튜토리얼 같은 문서에서는 별도의 비용 없이 따라 ..
반응형

티스토리툴바