테크니컬 라이팅 (435) 썸네일형 리스트형 AI The Docs 2024 - 커밋 메시지로 문서 업데이트가 필요한지 확인하기 About the problem 어느 사용자가 글을 올렸습니다. 빈번하게 릴리스 되는(기능 변경이 있는) 제품을 다루고 있는데, 커밋 메시지와 문서를 비교해서 문서의 업데이트가 필요한지 여부를 확인할 수 있는지에 대한 문의였습니다. 릴리스 되는 내용이 명확하고 기능이 공개되기 전에 매뉴얼 담당자에게 전달이 된다면 문제가 없겠지만, 많은 조직에서 기능 릴리스와 문서 업데이트가 별도의 프로세스로 동작합니다. 때문에 문서 업데이트를 놓치는 경우가 많죠(사실 프로세스가 있더라도 기능을 구현하면서 개발자가 문서 업데이트가 필요 없다고 생각해 매뉴얼 담당자를 프로세스에 배정하지 않는다면 놓치기도 합니다). 하여간 이 글을 보고 발표자는 한 가지 아이디어가 떠올랐고, 바로 검증을 해보았다고 합니다. ChatGPT에.. 2025년 10월 테크니컬 라이팅 이런 저런 소식 10월 10일AI The Docs Paris 2025https://apithedocs.org/ai-docs-paris-2025AI The Docs 행사도 코로나 이후 온라인으로 진행했는데, 올해부터는 오프라인 행사도 진행한다고 합니다.12월 파리에서 열리는 행사입니다. Survey now open for 2025https://salary-survey.writethedocs.org/WTD 커뮤니티에서 진행하는 연간 설문조사입니다. 급여를 중심으로 테크니컬 라이터가 일하는 환경까지 조사합니다. 올해 들어 유난히 새로운 일을 구하기 어렵다는 이야기들이 많아서 이번 설문 결과가 이전과 얼마나 달라질지 궁금하네요.We hope that this data can help our community members d.. AI The Docs 2024 - 기술적인 한계로 좌절했던 경험을 떠올려보세요 Meaghan Choi는 메타에서 6년 정도 제품 디자인 매니저로 일했고 현재는 Cloudflare에서 AI와 개발자 경험을 통합하는 일을 담당하고 있습니다. 제품 디자인 분야에서 오랜 기간 경험을 통해 개발자들의 작업에 필요한 다양한 접점에 대해 잘 알고 있다고 합니다. 개발자들이 최소한의 학습으로 원하는 성과를 만들 수 있게 하는 것이 목표입니다. 요즘 AI라고 생각할 때 가장 일반적인 형태는 챗봇입니다. 챗봇을 개발자 관점에서 본다면 CLI와 크게 다르지 않습니다. CLI의 관점에서 챗봇을 생각한다면 할 수 있는 더 많은 일을 떠올릴 수 있습니다. AI 시대 이전 CLI에서 하지 못해서 번거롭게 처리했던 일들을 AI와 통합을 통해 해결할 수 있는 아이디어를 찾을 수 있습니다. 예를 들어 CLI에서 .. AI The Docs 2024 - 문서에 AI 에이전트 붙이면 끝인가요? Camunda는 기업의 복잡한 비즈니스 프로세스를 설계, 실행 및 제어하는 데 사용되는 프로세스 오케스트레이션 및 자동화 플랫폼을 제공하는 기업입니다. 제품 문서에 AI 에이전트를 제공하고 있다고 설명하는데, 일단 사이트를 보면 kapa.ai를 사용하는 듯합니다. https://docs.camunda.io/문서에 AI 기능을 추가하려고 할때 구현하고자 하는 최소한의 요구사항을 4가지로 정리했습니다. - Cite the Sources AI 질의로 만들어진 콘텐츠가 어떤 출처에서 만들어졌는지, 사용자가 추가적인 정보를 원한다면 어느 문서로 이동해야 하는지 알 수 있어야 합니다. 초기 ChatGPT에서 답변의 출처에 대한 문제가 많았는데, 최근에는 어느 정도 추가 정보를 제공하고 있죠. 실제 질의 결과를 보면.. AI The Docs 2024 - 문서 챗봇 프레임워크를 만들었던 적이 있습니다만 문서상의 발표 제목은 "The Emerging Generative AI Content Ecosystem"입니다. MongoDB 팀에서는 자체적으로 챗봇 프레임워크를 만들고 이를 문서에 적용을 했었는데, 현재는 deprecated 상태입니다. 발표에서 3명 규모의 팀이라고 했는데, 자체 챗봇 프레임워크를 관리하기에 적은 숫자이고(아마 다른 일도 같이 하면서 했을 테니) 좀 더 좋은 환경을 제공하는 프레임워크가 있기 때문에 자체 프레임워크를 유지할 필요는 없다고 판단한 것 같습니다. 서비스 중단과 관련된 자세한 내용은 다음 링크에서 확인할 수 있습니다. https://mongodb.github.io/chatbot/framework/ 발표 내용은 챗봇 프레임워크에 대한 내용보다는 일반적인 생성형 AI에 대한.. AI The Docs 2024 - 부족한 일정 내에 새로운 문서를 만들어야 한다면 발표자가 최근 진행한 실제 프로젝트에서 활용했던 것이라고 합니다. 최근 7개의 서로 다른 API가 있는 SDK 제품을 위한 문서를 제한된 시간 내에 작성해야 하는 미션이었다고 합니다. 검토할 자료가 너무 많아서 수작업으로는 시간 내에 마칠 수 없어서 AI의 도움을 받았다고 합니다. 완전한 자동화는 아니지만, 대량의 자료를 검토하고 문서를 작성할 때 작업 시간을 줄일 수 있는 가이드 정도로 보면 될 것 같네요. 5가지 프로세스에 대해 설명합니다. 발표 영상에서는 제한된 시간 때문에 짧게 이야기했는데, 각 단계에 대한 상세 내용과 영상을 자신의 사이트에 공유해 놓았습니다. 자세한 내용은 링크를 참고하세요. 1. Gather source material 문서의 초안을 작성하기 위해서는 관련 소스 자료를 준비해.. 2025년 9월 테크니컬 라이팅 이런 저런 소식 9월 1일Cancelling WTD Australia 2025 conferencehttps://www.writethedocs.org/conf/australia/2025/news/cancel-announcement/...but with the stress of the current job market and uncertainties emerging from a rapidly changing work environment, this is a good time to take a break...WTD 호주 2025 행사 일정이 취소됐습니다. 정확한 사유는 언급하지 않고 있는데, 아마도 참여 신청자의 수가 줄어든 것 때문이 아닌가 싶습니다. 최근의 취업 시장이 참여에 영향을 주었을 것이라고 하구요. 9월 12일A.. AI The Docs 2024 - 미드로 알아보는 AI Qdrant에서 2024년 1월부터 4월까지 짧은 시간 일을 했습니다. 현재는 NGINX 정규직으로 일하고 있구요. Qdrant라는 기업은 오픈 소스 벡터 검색 데이터베이스 제품을 만드는 곳이라 AI 특히 RAG 분야에 특히 연관된 일을 했던 것 같습니다. 그래서 그 짧은 기간 동안 발표자는 AI에 대해 좀 더 깊게 공부할 수 있었다고 합니다(참고로 이 발표는 24년 8월 진행된 발표입니다). 4가지 주제로 이야기를 했는데요. 그 중에서 "Ragging on RAG"라는 내용은 아래와 같은 내용입니다. 나머지 주제는 살짝만 언급하고 넘어가서 잘 모르겠네요. 1990년대 시트콤인 사인필드에 대해 이야기합니다. 사실 이 시트콤을 잘 모르면 내용을 이해하기 힘든데요. 대충 정리하면 다음과 같은 이야기라고 합.. 이전 1 2 3 4 5 6 7 8 ··· 55 다음
