본문 바로가기

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

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

반응형

3월 4일

내가 사용하는 맞춤법 검사기는?

2월 23일 맞춤법 검사기에 대한 동영상을 올리면서 진행한 설문입니다(지난달에 올린다고 하는 것을 잊어버리고 3월 첫 소식인 것처럼 ㅠㅠ)

https://youtu.be/cDwcUKslhHQ?si=ptn9ytGEcfL-Z3DU

 

네이버가 80%로 1위, 부산대 맞춤법 검사기가 15%로 2위네요. 다음은 1%. 네이버 맞춤법 검사기는 의외로 사용성이 좋지 않은데도 다음과 비교가 되지 않는군요 ㅠㅠ

https://www.youtube.com/post/UgkxRNAeasOal82GqkRToxSXY_NWUxTWETXF

 

A NEW CHAPTER FOR A BOOK APART

https://abookapart.com/blogs/press/a-new-chapter-for-a-book-apart

웹사이트 관련 디자인, 기술 서적을 출판하던 A Book Apart에서 이후 새로운 책을 펴내지 않는다고 발표했습니다. 

...More recently, it is testing the sustainability of our business, and after careful consideration we will no longer be publishing new titles...

공지된 글만으로 자세한 내용은 알 수 없지만 기술 서적 출판 시장의 불황 때문이 아닌가 추측해 봅니다.

국내에서는 웹액츄얼리에서 "아름다운 웹사이트 만들기"라는 타이틀로 28권까지 번역, 출판을 했습니다.

 

3월 5일

딥엘(DeepL), 인기 서비스 ‘용어집’ 한국어 지원 시작

기사 타이틀이 좀 이상한데 유료 서비스를 시작하면서 기본적으로 제공되어야 하는 기능이 이제야 제공되는 것이 아닌가 싶습니다. 용어집은 유료인 경우에는 계정 단위로 관리되고 무료 사용자는 브라우저 단위로 관리된다고 합니다. 

https://n.news.naver.com/mnews/article/018/0005685505?sid=105

https://support.deepl.com/hc/ko/articles/360021638100-%EC%9A%A9%EC%96%B4%EC%A7%91-%EC%82%AC%EC%9A%A9-%EA%B0%80%EB%8A%A5-%EC%97%AC%EB%B6%80

 

3월 6일

티맥스소프트 직무와 회사생활에 대해 알아보는 직.찐.인.터.뷰 👨📹 | 기술문서편👩🏻‍💼

티맥스소프트 기술문서파트 이가연 파트장 인터뷰입니다. 1분이 안 되는 짧은 시간이라 간단한 소개 정도입니다.

최근 테크니컬 라이터 모집 공고가 뜸하지만 티맥스는 공개적으로 꾸준히 테크니컬 라이터를 모집하는 회사 중 하나죠.

https://youtu.be/w2ylH-w7wF4?si=nMyvUBtsC0mJBBPw

 

3월 20일

더 자유롭고, 빠르고, 정확하게: 토스페이먼츠 API 문서 엔지니어링

https://toss.tech/article/docs-engineering

토스페이먼츠에서 API 문서를 어떻게 작성하고 배포하는지 자세하게 설명하고 있습니다.

중간중간 나오는 낯선 용어에 대한 정보는 용어사전에서도 참고할 수 있네요.

예를 들어 OAS 같은 경우는 https://docs.tosspayments.com/resources/glossary/oas

 

3월 22일

나무위키 목차지도

이건 새로운 소식은 아니고 이제야 제가 발견을 해서 ^^

요즘에는 웹 문서의 목차를 오른쪽 영역에 고정시켜 보여주는 형태를 많이 볼 수 있습니다.

 

화면 폭이 좁은 모바일 환경에서는 메뉴를 감추고

 

화면 폭이 적절한 환경에서는 메뉴 영역을 보여주는 형식입니다.

왼쪽에는 페이지 연결 메뉴를 보여주고 오른쪽에는 페이지 내 목차를 표시해 줍니다. 보통은 TOC(Table of Contents)라고 많이 하는 것 같네요.

 

 

뭐 하여간 보통은 위와 같은 식으로 오른쪽 영역에 고정해서 표시를 하는데 나무 위키는 좀 색다르게 사용자가 마우스를 가까이 갔을 때만 표시합니다. 적절한 화면 폭 조건에서만 점 표시가 노출되고 점 영역 위에 마우스를 가져가면 목차가 표시됩니다.

 

 

해당 기능은 2024년 1월 30일 즈음에 업데이트된 것 같습니다. 기능 이름은 "목차 지도"입니다.

https://namu.wiki/w/%EB%82%98%EB%AC%B4%EC%9C%84%ED%82%A4:%EA%B8%B0%EB%8A%A5%20%EB%8F%84%EC%9B%80%EB%A7%90#s-2

 

openNAMU 이슈에 관련 요청 사항이 올라온 것이 있는데 "목차 지도" 기능은 예전에 무나키위에 있던 기능과 비슷하다고 하네요.

https://github.com/openNAMU/openNAMU/issues/2022

호불호가 있을 것 같긴 한데 문서가 긴 경우 TOC가 문서 영역을 가리지 않고(보통 TOC를 설정하면 영역을 차지하기 때문에) 간략한 방식으로 보여주는 기능으로는 좋을 것 같습니다.

참고로 이 블로그에도 TOC 플러그인을 적용했다가 뭔가 동작이 이상해서 다시 삭제한 상태입니다. 딱히 문서 작성 시 제목을 잘 작성하는 스타일도 아니라서 ㅠㅠ

 

3월 25일

TCN meetup 2024.04

2022년 TCN 운영진 개편 이후 오프라인으로 행사를 하는 건 처음인 것 같네요.

일정은 4월 30일이고 티켓은 4월 22일부터 접수한다고 합니다. 

아직 발표 세션은 확정되지 않은 상태입니다.

FAQ를 보면 영상 녹화는 제공하지 않는다고 합니다. 좀 아쉬운 부분이긴 하네요.

https://rkttu.notion.site/TCN-meetup-2024-04-b65394394066453393ce107c238ecf45

 

3월 29일

esbuild와 Redis, 훌륭한 아키텍처 문서를 갖춘 두 개의 오픈 소스 프로젝트

(Two open source projects with great architecture documentation)

내용이 잘 요약, 번역되어 있어서 따로 옮길 내용은 없을 것 같네요. 테크니컬 라이터의 역할보다는 개발팀 내에서 문서화에 대한 내용을 담고 있습니다.

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

https://news.ycombinator.com/item?id=39819409

 

esbuild 같은 경우에는 Evan Wallace가 주도하는 오픈소스 프로젝트라 문서의 경우에도 히스토리를 보면 Evan Wallace가 직접 작성한 것이 아닌가 싶습니다. 반면에 Redis는 테크니컬 라이터를 계속 뽑고 있는 것을 보면 상업적인 라이선스와 오픈소스 라이선스 사이의 문서화가 어떻게 진행되고 있는지도 확인이 필요할 듯 합니다.

변경 이력 같은 경우 대부분 이러이러한 것을 수정했습니다. 정도로 끝나는데 esbuild의 경우에는 코드 단에서 어떻게 수정이 되었는지 정리해서 설명을 하고 있습니다.

https://github.com/evanw/esbuild/blob/main/CHANGELOG.md

728x90