테크니컬 라이팅 (420) 썸네일형 리스트형 AI The Docs 2024 - 이제는 개발자 솔루션 포털의 시대다 Kristof Van Tomme는 Pronovix의 CEO입니다. Pronovix의 주요 사업이 개발자 포털을 만드는 것인데, AI 시대에 더 이상 문서화나 개발자 포털이 필요한가에 대한 질문을 많이 받았다고 합니다. 발표자의 생각으로는 AI 시대에 문서화와 API는 그 중요성이 더 커진다는 겁니다. 중간에 이런저런 이야기가 있지만 결론적으로는 개발자 포털을 넘어서 개발자 솔루션 포털을 강조합니다. 개발자에게 단순히 정보를 제공하는 것이 아니라 사용자가 자동화된 통합 기능을 구축할 수 있는 일련의 솔루션을 제공하는 방식을 제시합니다. 그 예로 stripe의 최근 개발자 포털 사이트를 예로 듭니다. 예전에는 각 기능에 대한 API 문서가 강조되었는데, 지금은 특정 작업에 관련된 API, 문서 등을 통합적으.. 2025년 12월 테크니컬 라이팅 이런 저런 소식 12월 2일AWS 클라우드 리드 블로거 윤석찬 님의 페이스북 게시물입니다.두 번째 게시물부터 읽어서 몰랐는데, 약간 연재물 느낌이네요. 지난 11월 23일에 첫 번째 글이 올라오고 27일에 두 번째 글이 공개됐습니. 작은 규모의 조직에서는 블로그 게시물을 혼자 쓰고 혼자 검수하고 혼자 발행하는데, 좀 더 체계적이고 큰 조직에서는 어떻게 활용하는지 엿볼 수 있는 글입니다. (업데이트) 윤석찬 님 블로그에 계속 업데이트되고 있네요. 여기에 추가로 모을 필요는 없을 것 같습니다 ~~https://channy.creation.net/blog/1966 - 첫 번째 글집에서 가끔 쫄면을 직접 해 먹고 있다. 면뿐만 아니라 양배추, 당근, 사과를 듬뿍 잘게 썰어서 넣고 양념장에 비비면 일품이다. 그런데, 다 먹고 나.. AI The Docs 2024 - 코드 생성을 위한 OpenAPI 스펙 만들기 이번 세션은 문서화보다는 OpenAPI 스펙 관점에서 설명하는 내용이라 살짝 애매합니다. AI 보다는 코드 생성이 중요한 곳에서 OpenAPI 스펙을 어떻게 만들어야 하는지 설명하는 내용이라고 볼 수 있네요. - We don't have an OpenAPI spec The Problem: "We've put off creating a spec. We want to make one, but we aren't sure if we should generate it or hand-maintain it." The Solution: Pick one, or try both and see what sticks. Every org is different. OpenAPI 스펙을 유지하는 방법이 정해진 정답이 있는 것은 아.. AI The Docs 2024 - 아직까지는 콘텐츠가 중요하다 Nick Gomez는 Inkeep의 공동 창업자입니다. MIT 출신으로 마이크로소프트를 거쳐 2023년에 창업을 했습니다. 아마도 이번 행사에 참여한 것은 솔루션 홍보를 위한 목적이겠지만, 세션 내내 제품 이야기를 할 수는 없으니 효과적인 RAG 구성을 위한 팁을 제시합니다. - Hierarchy is important 이건 모든 이들이 강조하는 부분입니다. 적절한 헤더를 설정하고 계층적인 구조를 만들어야 합니다. 그리고 콘텐츠의 형태도 주제>질문>응답의 형태 또는 FAQ 형식으로 작성되어야 합니다. 이런 콘텐츠 형태는 요즘 자주 언급되긴 하는데 기술이 발전하면 필요 없다는 이야기가 나올 수도 있습니다(개인적으로는 특정한 정답을 가지고 있는 구조라면 굳이 LLM을 사용하는 것이 효과적일까 싶기도 하구요).. AI The Docs 2024 - 우리 조직의 문서 시스템에 구멍난 부분을 찾아내기 2018년에 챗봇을 개발했던 경험과 비교해서 최근의 기술이 얼마나 혁신적인지 이야기합니다. 기본적인 것은 AI가 처리해 주고 개발자들은 대화의 품질을 높이는 활동에 집중할 수 있습니다. 트렌드의 변화에 따라 문서를 개선하고 다시 작성해 주면 개발자 만족도는 높아질 수 있습니다. 규모가 작은 경우에는 가능한 일이겠지만, 규모가 큰 조직에서는 당연히 모든 문서를 다시 작성하는 것은 불가능한 일입니다. RAG 시스템을 구현한다고 해서 한 번에 결과를 만드는 것은 아닙니다. 지속적으로 최적화 작업이 필요합니다. 다른 세션에서도 이야기했듯이 사용자의 질의를 분석한다는지 부족한 정보를 채우는 일은 여전히 사람의 몫입니다. 마스터 카드에서 어떤 도구를 사용하는지 모르겠지만 문서 시스템을 시각화해서 보여준 것이 인상적.. 2025년 11월 테크니컬 라이팅 이런 저런 소식 어쩌다 보니 벌써 10일이네요 ㅠㅠ 11월 10일AWS tech writers majorly impacted by today's layoffshttps://www.reddit.com/r/technicalwriting/comments/1oicnxi/aws_tech_writers_majorly_impacted_by_todays/글이 올라온 것은 지난달 29일입니다. 제가 게을러서 이제야 소식을 공유해 봅니다.AWS, 아마존에서 지난달 말 수천 명을 해고하는 일이 있었는데요. 작성자에 따르면 테크니컬 라이팅 조직 중 상당히 큰 부분이 포함되었다고 합니다. 물론, AWS, 아마존에서 일하는 테크니컬 라이터가 수백 명이기 때문에 정확하게 어느 정도가 대상이 되었는지 알 수는 없습니다(작성자도 구체적인 수치를 언급.. AI The Docs 2024 - 이번 세션은 kapa.ai 영업 활동입니다 2024년 행사에서도 자주 언급된 기업이죠. kapa.ai 공동 창업자인 Emil Soerensen의 발표입니다. 창업을 하기 전에는 매킨지에서 컨설턴트, 매니저로 일했고 바로 창업을 했네요. 학부는 경영학, 경제학 쪽인데 석사를 컴퓨터 공학으로 받았습니다. 아마 이때부터 창업을 준비한 것이 아닌가 싶네요. 발표는 3가지로 설명합니다. LLM 개요와 기술 문서에서 LLM을 어떻게 활용하는지, Q&A 순서입니다. LLM을 설명한다고 하지만 아무래도 제품을 설명하지 않을 수 없다 보니 전반적으로 kapa.ai 중심으로 설명이 진행됩니다. LLM에 대한 설명은 실제로 kapa.ai가 어떻게 동작하는지를 가지고 설명합니다. 1. Connect technical knowledge sources 일반적으로 문서에 .. AI The Docs 2024 - API 연동에 도움이 되는 문서 만들기 API를 제공하면서 부족한 문서 품질은 사용자가 원하는 기능을 쉽게 찾을 수 없고 결국에는 API 채택에 영향을 미칩니다. OAS(Open API Specification)나 AsyncAPI specification 기반으로 만드는 문서는 사용자가 빵을 만들 수 있는 각각의 재료만 제공할 뿐 어떻게 만들어야 하는지 구체적인 레시피를 제공하지는 않습니다. 실제 사용자가 원하는 작업을 진행하기 위해서는 여러 API를 필요와 순서에 따라 사용해야 하는데(레시피) 이런 가이드가 부족하다는 이야기입니다. 이러한 레시피를 포함해 API를 사용할 때 고려해야 할 여러 가지 요소가 사용자뿐 아니라 AI에게도 중요한 요소입니다. 사용자가 겪는 어려움을 AI도 겪을 수 있다는 이야기입니다. 간단한 데모를 진행합니다. 애.. 이전 1 2 3 4 5 ··· 53 다음
