본문 바로가기

테크니컬 라이팅/이런 저런 소식

2024년 1월 테크니컬 라이팅 이런 저런 소식

반응형

1월 5일

UX 라이팅, 배민은 이렇게 시작했어요

작년 11월에 올라온 글인데 우아한테크 뉴스레터를 보다가 발견(?)했습니다.

개인적으로는 글쓴이 소개글이 맘에 드네요.

"디자인으로 사고하고 글로 빚어내는 일을 해요"

 

https://story.baemin.com/6287/

 

1월 8일

개발자의 글쓰기 : Technical Writing #

"사내 스터디 메이트"라는 SK 소모임에서 "Docs for Developers 기술 문서 작성 완벽 가이드" 책을 가지고 스터디하고 그 결과물을 5회에 걸쳐 블로그에 게시했습니다. 작성자가 다 다른데요. 

책을 읽는 분들에게도 내용을 정리하는데 도움이 될 듯합니다.

1회(victor): https://devocean.sk.com/search/techBoardDetail.do?ID=165343

2회(Groche): https://devocean.sk.com/blog/techBoardDetail.do?ID=165446

3회(Isidore): https://devocean.sk.com/blog/techBoardDetail.do?ID=165511

4회(eagle705): https://devocean.sk.com/blog/techBoardDetail.do?ID=165514

5회(lhj321): https://devocean.sk.com/blog/techBoardDetail.do?ID=165558

 

1월 9일

작년 12월 7일~8일 진행했던 Write the Docs Australia 행사 영상과 관련 기록이 공개됐습니다.

다양한 주제 세션과 패널 토의까지 진행이 되었습니다.

자세한 내용은 아래 링크를 참고하세요.

https://www.writethedocs.org/conf/australia/2023/news/thanks-recap/

 

1월 16일

MadCap에서 Xyleme을 인수했다고 합니다. 발표는 11일에 했네요. MadCap이 차지하는 비중이 10% 미만이라 큰 뉴스는 아니지만 기존 사용자들은 일단 환영하는 분위기입니다.

MadCap Software Acquires Xyleme to Expand Suite of Intelligent Content Management Products

https://www.madcapsoftware.com/press-release/madcap-software-acquires-xyleme/

 

GeekNews에 scalar.com에 대한 소개글이 올라왔는데요. "2011년에 만들어진 것 같지 않음"이라는 문구가 있길래 뭔가 했습니다. 원문은 "Doesn’t look like it’s 2011". SwaggerUI에 대응하면서 Swagger가 2011년에 만들어진 것을 돌려까는 것이 아닌가 싶네요.

scalar.com - API 문서화 및 SwaggerUI 대체제

https://news.hada.io/topic?id=12723

 

1월 17일

챗GPT활용, 테크니컬 라이팅

서울시 관악복합평생교육센터에서 진행하는 강의입니다. 오프라인 강좌이고 무료인데 수요일 오후에 진행되는군요.

강사가 미정이라~ 좀 이상하긴 하지만 이렇게 공개된 테크니컬 강의가 없었는데 챗GPT가 붙어서 진행되는 것이 신기하네요.

https://seoullifelong.co.kr/?module=Board&action=SiteBoard&sMode=VIEW_FORM&iBrdNo=3&iBrdContNo=29&sBrdContRe=0

 

1월 19일

슬랙봇을 활용한 기술 블로그 배포 자동화 이야기

블로그 콘텐츠 초안을 노션에서 작성, 리뷰하고 최종 결과물을 사이트에 게시하는 과정을 자동화한 경험을 공유한 이야기입니다. 이게 대량의 콘텐츠 이전이 아니라서 기존 5~7분 정도 걸리는 일이 1분으로 줄었다고 하는데 혹 배포 형식을 바꾸거나 채널이 바뀌어야 하는 경우 대량의 콘텐츠를 옮기는 경우에는 엄청난 시간을 절감할 수 있는 일입니다. 또한 배포되는 글이 많은 경우에도 마찬가지구요.

https://insight.infograb.net/blog/2024/01/10/slack-bot/

 

1월 22일

기술 문서 사이트로 Docusaurus 활용하기

라인 전정은님이 정리해주신 도큐사우루스 활용기입니다. 라인의 경우 여러 SSG 플랫폼을 사용하는데 팀 공용으로 사용할 플랫폼으로 도큐사우루스를 선정했다고 하네요.

https://techblog.lycorp.co.jp/ko/docusaurus-as-a-technical-document-website

 

기술 문서 사이트로 Docusaurus 활용하기

Static site generator(이하 SSG)는 웹 문서나 간단한 웹사이트를 만들려는 사람이라면 한 번쯤 들어봤을 단어일 겁니다. 소프트웨어 플랫폼이나 제품 사이트 중에도 ...

techblog.lycorp.co.jp

 

블록체인 개발자 문서가 도큐사우루스를 적용한 사례라고 합니다. 2.4.0 버전을 사용하고 있네요. 검색 기능은 Algolia 대신 typesense를 적용했습니다.

https://docs-blockchain.line.biz/ko/how-to/provide-item-token-images

 

참고로 도큐사우루스는 작년 10월 3.0을 공개했고 1월에 3.1로 업데이트했습니다.

https://docusaurus.io/blog/releases/3.1

 

1월 24일

STC’s 2024 Summit & Industry Expo registration is now open!

STC 서밋 등록이 오픈됐습니다. 국내에서도 유명한 기업들은 참여하는 곳이 많더군요(찾아보면 코로나 이전 후기들을 볼 수 있습니다). 4월 26일까지 등록해야 얼리버드 혜택을 받을 수 있습니다. 행사는 5월 17일부터 19일까지 미내소타 미니애폴리스에서 진행됩니다.

https://summit.stc.org/registration-rates/

 

1월 25일

토스 기술 블로그에 개발 문서 관련 이야기가 두 번에 걸쳐 올라왔습니다.

첫 번째는 테크니컬 라이터가 무슨 일을 하는지, 두 번째는 토스에서 테크니컬 라이터가 개발자 학습을 지원하기 위해 어떤 일을 하고 있는지를 이야기합니다.

그 많은 개발 문서는 누가 다 만들었을까

(1) 토스페이먼츠 테크니컬 라이터가 하는 일

https://toss.tech/article/tech-writer-1

(2) 개발자의 학습을 돕는 모든 것

https://toss.tech/article/tech-writer-2

 

1월 31일

AI The Docs 2024

아직 발표자도 정해지지 않은 컨퍼런스입니다. API the Docs에서 진행하는 행사로 이미 관련 컨퍼런스에서 AI 관련된 주제가 많이 나오고 있으니 아예 이들을 모아서 진행하려는 듯합니다.

https://ti.to/pronovix/ai-the-docs-2024

 

728x90