본문 바로가기

분류 전체보기

 (2674)
[리뷰] DQTI (5) 2장 Developing quality technical information 1장은 3판을 위한 개요라고 한다면 2장은 전통적인 DQTI를 위한 개요입니다. 하지만 이전 판과는 내용이 좀 다르긴 합니다. 2판(1장)과 3판(2장)의 첫 문장을 비교해 볼까요? (2판)What is technical information? And how is quality technical information different from just technical information? 장 제목 그대로 반영된 첫 문장입니다. 기술 정보가 무엇이고 양질의 기술 정보는 무엇이 다른지 이 책에서 설명하겠다는 내용입니다. (3판) The evolution in technical information isn’t just about delivery formats. It’s also about refinin..
AI The Docs 2024 - API 연동에 도움이 되는 문서 만들기 API를 제공하면서 부족한 문서 품질은 사용자가 원하는 기능을 쉽게 찾을 수 없고 결국에는 API 채택에 영향을 미칩니다. OAS(Open API Specification)나 AsyncAPI specification 기반으로 만드는 문서는 사용자가 빵을 만들 수 있는 각각의 재료만 제공할 뿐 어떻게 만들어야 하는지 구체적인 레시피를 제공하지는 않습니다. 실제 사용자가 원하는 작업을 진행하기 위해서는 여러 API를 필요와 순서에 따라 사용해야 하는데(레시피) 이런 가이드가 부족하다는 이야기입니다. 이러한 레시피를 포함해 API를 사용할 때 고려해야 할 여러 가지 요소가 사용자뿐 아니라 AI에게도 중요한 요소입니다. 사용자가 겪는 어려움을 AI도 겪을 수 있다는 이야기입니다. 간단한 데모를 진행합니다. 애..
[리뷰] DQTI (4) 1장 Technical information continues to evolve 1, 2장은 Introduction 파트입니다. 장 제목에서 알 수 있듯이 테크니컬 인포메이션 분야는 지금도 계속 새로운 방향으로 나아가고 있고, 그 과정에서 이 책을 펴낸 것이다라는 의미를 강조하고 있습니다. 이 책이 출판된 것은 2014년인데, 이제 막 Headless 개념이 등장하면서 한번 더 테크니컬 라이팅 시장이 바뀌기 시작할 때입니다. 이 책의 저자들이 90년대 경력을 시작했다면 DTP, 온라인 문서, CMS 등의 변화를 몸으로 겪은 세대였다는 거죠(3판 저자는 대부분 80년대 후반에서 90년대 초반에 졸업을 했습니다. 졸업 후 바로 경력을 시작했다면 90년대 경력을 시작한 것으로 볼 수 있죠). In testing, when users were forced to seek additional ..
AI The Docs 2024 - AI 시대 콘텐츠는 어떻게 작성해야 하는가? 기존 콘텐츠를 크롤링하는 봇은 콘텐츠를 읽긴 하지만 그에 대한 판단은 내리지 않습니다. 단지 수집을 하는 것이죠. 하지만, AI 시대의 봇은 문서를 판단합니다(정확하게는 봇이 그러는 것은 아니지만). 그래서 어떤 분야에서는 AI에게 적합한 콘텐츠를 만들어야 한다는 주장을 하기도 하고 여러 실험을 통해 검증하기도 합니다. 한국일보에 기고한 김경달 고려대 교수의 "기계고객 시대의 해법…'가장 인간적인 것'"이라는 글도 비슷한 맥락이죠. https://n.news.naver.com/mnews/article/469/0000892960?sid=110...이러한 변화는 정보 환경도 뒤흔든다. 검색 상위 노출을 위한 SEO(검색 엔진 최적화)의 시대가 가고, 생성 AI의 답변에 우리 서비스가 추천되도록 만드는 GEO..
[리뷰] The Nurnberg Funnel 서울경제 2015년 2월 27일 "설명서의 멸종"이라는 기사 일부입니다. 퍼퓰러 사이언스 기사 "The Disappearance Of The Instruction Manual"를 번역한 글입니다. https://www.popsci.com/instructions-not-included/https://www.sedaily.com/NewsView/1H91FUT94V...그는 연구실에 비서를 채용해 컴퓨터와 사용설명서를 지급한 뒤 일상적 사무를 처리토록 지시했다. 결과는 당혹스러웠다. 피실험자인 비서들이 매뉴얼을 읽을수록 오히려 혼란에 빠지는 사례가 많았던 것이다. "비서 희망자들이 매뉴얼을 읽은 뒤 저를 올려보며 이렇게 말하더군요. '이 일은 제가 못하겠어요.'라고요. 그리고는 일어서서 코트를 입고 사라졌죠...
발판을 마련하다 레딧에 올라온 글 중에 올해 초 테크니컬 라이팅 전공으로 졸업을 했는데, 아직도 취업을 못하고 있다는 글이 올라왔습니다.Hard time getting my foot in the doorhttps://www.reddit.com/r/technicalwriting/comments/1o6jngy/hard_time_getting_my_foot_in_the_door/커리어를 어떻게 시작해야 할지 난감하다는 이야기죠. 예전에는 신입 커리어를 시작하려 하는데 이런저런 경력을 요구해서 어려웠는데, 요즘에는 경력이 있어도 새로운 자리를 잡기 어려운 시기이긴 합니다. 하여간 저 제목이 처음에는 무슨 이야기인가 싶어 번역기를 돌려 보았더니 "발판을 마련하다"라는 표현이 나왔습니다.대충 느낌은 알겠는데, "발판"이라는 단어가..
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..
반응형

티스토리툴바