테크니컬 라이팅 (408) 썸네일형 리스트형 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도 겪을 수 있다는 이야기입니다. 간단한 데모를 진행합니다. 애.. AI The Docs 2024 - AI 시대 콘텐츠는 어떻게 작성해야 하는가? 기존 콘텐츠를 크롤링하는 봇은 콘텐츠를 읽긴 하지만 그에 대한 판단은 내리지 않습니다. 단지 수집을 하는 것이죠. 하지만, AI 시대의 봇은 문서를 판단합니다(정확하게는 봇이 그러는 것은 아니지만). 그래서 어떤 분야에서는 AI에게 적합한 콘텐츠를 만들어야 한다는 주장을 하기도 하고 여러 실험을 통해 검증하기도 합니다. 한국일보에 기고한 김경달 고려대 교수의 "기계고객 시대의 해법…'가장 인간적인 것'"이라는 글도 비슷한 맥락이죠. https://n.news.naver.com/mnews/article/469/0000892960?sid=110...이러한 변화는 정보 환경도 뒤흔든다. 검색 상위 노출을 위한 SEO(검색 엔진 최적화)의 시대가 가고, 생성 AI의 답변에 우리 서비스가 추천되도록 만드는 GEO.. 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에서 .. 이전 1 2 3 4 ··· 51 다음
