본문 바로가기

728x90

전체 글

(2447)
2023년 9월 테크니컬 라이팅 이런 저런 소식 9월 6일 - 카카오페이 기술 블로그는 어떻게 만들었을까요? 라는 제목의 글입니다. 기획보다는 구현 기술 쪽에 초점을 맞추어 작성한 글이네요. Gatsby로 만들고 Astro로 마이그레이션 한 경험도 담겨 있습니다. https://tech.kakaopay.com/post/kakaopay-techlog/ 카카오페이 기술 블로그 내용 중 용어집 개발과 관련된 글도 있습니다. 물론 자세한 이야기는 없지만 용어집을 봇 형태로 개발하고자 한다면 참고할만한 내용입니다. https://tech.kakaopay.com/post/dictionary-bot/ - WRITE THE DOCS ATLANTIC 2023 행사 티켓이 마감된다는 소식입니다. 행사는 9월 10일부터 12일까지 온라인으로 진행됩니다. 세션 영상은 아마..
문서 업데이트 시 AI 활용하기 Using AI to create doc updates based on bugs 라는 문서에 대한 번역입니다. 개인적인 학습 용도이며, 아마도 이 글을 보는 것보다 이 글을 작성한 시점보다 좀 더 나아진 기계번역의 힘을 빌리는 것이 좀 더 좋은 방법이라 생각됩니다. https://idratherbewriting.com/learnapidoc/docapis_ai_fix_bugs.html Using AI to create doc updates based on bugs Download PDF idratherbewriting.com 저는 사용자가 등록한 버그를 상시 확인하고 문서를 업데이트합니다. 이런 작업은 새로운 기능에 대한 문서를 작성하는 것이 아니라 이미 공개된 문서에 대한 수정이 필요한 상태입니다. 예를..
챗GPT 번역투 해결법 전자책으로만 출판된 책입니다. 약 2만 자로 구성되어 있고 A4 기준으로 13페이지라고 합니다. 일부 내용은 챗GPT의 답변으로 채워져 있습니다. 4장으로 구성되어 있습니다. 1장. 챗GPT 번역투 발생원인 뭐 여러가지가 있으나 기본적으로 학습 데이터 중 많은 양의 데이터가 영어이고 한국어인 경우에도 번역투로 작성된 한국어를 학습해 결과적으로 번역투가 나올 수 있다고 합니다. 개인적으로는 챗GPT의 문장을 그대로 가져와서 사용한 적은 없어서 체감하지 못하고 있지만 과제 등을 위해 결과물을 가져오고자 할 때 어색한 부분이 많다고 합니다. 2장. 번역투 문장과 자연스러운 우리말 번역투가 뭔지 알아야 해결할 수 있으니깐. 하지만 이 부분이 사실 어렵습니다. 그냥 익숙하게 쓰는 문장이라서 쓰면서도 번역투인지 아..
WTD 포틀랜드 2023 - 크라우드 소싱 방식의 문서화 프로젝트 진행하기 이번 발표에서 설명하는 Splunk Lantern이라는 프로젝트의 방식이 좀 낯설어서 전체적인 내용을 제대로 이해하지 못했습니다. 뭐 그럼에도 부족한 자원을 가지고 기여자들과 함께 문서화 프로젝트를 진행하는 여러 팁에 대해 설명하고 있는 것이라서 유익한 팁들만 받아들이면 되지 않을까 싶습니다. Splunk Lantern은 - 공식 제품 문서와 다르게 릴리스 일정과 상관없이 운영됩니다. - 커뮤니티가 아니기 때문에 누구나 문서화에 참여할 수는 없습니다. - 마케팅 지향적인 문서를 만들지 않습니다. - 기술지원 요청에 대응해서 문서를 만들지는 않습니다. Splunk Lantern은 고객을 위한 디지털 셀프서비스 가이드입니다. 현장에서 고객과 함께 일하는 엔지니어들이 자료를 만들고 고객의 성공을 돕습니다. 라..
WTD 포틀랜드 2023 - 대규모 엔지니어 조직에서 생산성 높은 문서화 프로세스 만들기 Datadog에는 12명의 테크니컬 라이터가 일하고 있습니다. 일반적인 개론에서는 1명의 테크니컬 라이터가 10~15명 정도 엔지니어와 함께 일하는 것이 이상적이라고 합니다. 미국 통계에서는 약 30명의 엔지니어를 1명의 테크니컬 라이터가 대응하고 있다고 합니다. 하지만 Datadog에서는 2000여 명의 엔지니어가 일하고 있고 12명의 테크니컬 라이터는 이들 2000여 명의 엔지니어와 매일 커뮤니케이션을 진행합니다. 물론 2000여 명의 엔지니어가 모두 테크니컬 라이터 또는 문서화에 긴밀하게 참여한다고 할 수는 없습니다. 그중에 PM이나 팀 리더와 주로 많은 작업을 합니다. 사내 엔지니어 외에도 고객, 사용자, 파트너, 기술지원, 커뮤니티, 세일즈, 번역을 담당하는 이들과도 함께 일을 해야 합니다. 이..
2023년 8월 테크니컬 라이팅 이런 저런 소식 8월 1일 8월 첫 소식입니다. 지난 7월 27일 토스 페이먼트 트위터(이제는 엑스라고 해야 하나요 ㅠㅠ) 계정에 한글 변수명 사용에 대한 글이 올라왔습니다. "세종대왕 프로젝트"라는 이름으로 한글코딩 컨벤션에 대한 짧은 문서를 같이 공개했구요. https://tosspayments-dev.oopy.io/chapters/frontend/posts/hangul-coding-convention 세종대왕 프로젝트 (한글 코딩 컨벤션) 한글 코딩? 어려운 도메인 용어에 대해 변수명을 정할 때, 어색한 영어보다 이해하기 쉬운 한글로 짓는 컨벤션을 말합니다.보다 이해하기 쉽고 눈에 잘 들어오는 코드를 작성할 수 있다는 장점 tosspayments-dev.oopy.io 토스에서 코딩에 한글 상수, 변수를 사용한다는 ..
WTD 포틀랜드 2023 - 포용적인 언어에 대해 이번 세션 주제는 쉽지 않습니다. 발표자의 개인적인 경험을 담고 있고 여러 논쟁이 있는 주제라 그런 것 같습니다. 그래서 발표 전에 몇 가지 규칙을 미리 공지하고 진행합니다. 해당 규칙에 따라(아마 운영진과 합의된 것이 아닌가 싶습니다) Q&A는 진행하지 않았습니다. 주제는 트라우마와 포용적인 언어에 대한 이야기입니다. 트라우마라는 표현은 많이 들어보긴 했지만 실제 경험한 것이 아니라면 공감하기 쉽지는 않습니다. 한국에서는 2018년 국가트라우마센터가 설치됐습니다. 대형 재난에 대한 심리지원이 체계적으로 필요하다는 필요성 때문이었죠. 국가트라우마센터 사이트에서는 트라우마를 다음과 같이 정의하고 있습니다. https://www.nct.go.kr/itaewon/traumaIntro1.do ...트라우마란 재..
WTD 포틀랜드 2023 - 테크니컬 라이팅에 AI 활용하기 발표자는 Rokt라는 전자상거래 관련 솔루션 회사에서 테크니컬 라이터로 일하고 있습니다. 딱히 AI 관련된 기술에 가까이 있는 것은 아니고 개인적인 관심을 가지고 이런 저런 것들을 찾아보고 시도해보았다고 합니다. AI가 일상적으로 쓰인 것이 최근 일인 것 같지만 사실 검색어 입력 시 자동 완성이라든지 맞춤법 검사, 문법 검사 같은 장치들은 꽤 오래전부터 사용하고 있었습니다. 물론 이러한 것들을 의도적으로 쓰지 않는 분들도 있지만요. 기계 번역도 마찬가지입니다. 어떤 방식을 사용하든 AI가 어느 정도 개입하고 있었던 것들이죠. 테크니컬 라이터가 AI를 통해 얻을 수 있는 이점 - 생산성의 향상(반복직인 작업은 AI에게 맡기고 전체적인 문서 구조화 등 작업에 집중할 수 있음) - 콘텐츠 품질 향상(문법, 맞..

반응형