본문 바로가기

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

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

반응형

3월 2일

MDN 사이트가 전반적으로 개편됐습니다. 커뮤니티를 강화하고 접근성과 사용성을 강화했다고 합니다. 오랫동안 익숙했던 사이트라 변화가 막 반갑지는 않네요 ^^ 공룡 로고가 사라진 것도 아쉽고~

https://hacks.mozilla.org/2022/03/a-new-year-a-new-mdn/

 

참고로 MDN 사이트가 깃헙 기반으로 변경한 것은 2020년 12월입니다. 아마도 그 당시에는 기능은 유지한 채 소스만 이관하고 일부 수정한 듯하고요. 이번에는 전반적인 사용성 개선을 목적으로 개편이 된 것이고요.

https://hacks.mozilla.org/2020/12/welcome-yari-mdn-web-docs-has-a-new-platform/

 

https://developer.mozilla.org/en-US/docs/Web/JavaScript

 

3월 15일

5월 22일부터 24일까지 진행될 WTD 포틀랜드 발표자가 확정됐습니다.
Google Docs Advocate Erin McKean가 Google's Season of Docs Program에 대한 이야기를 전하는 세션도 있구요. AWS Marcia Riefer Johnston가 docs as code를 어떻게 만들었고 앞으로 어떤 식으로 발전시켜나갈 것인가에 대한 이야기도 있습니다.

Marcia Riefer Johnston는 꽤 오랫동안 강연 현장에 모습을 보이지 않아 그런지 복귀를 환영하는 분들이 많네요.

 


전체 세션 목록은 링크에서 확인하실 수 있습니다.

https://www.writethedocs.org/conf/portland/2022/speakers/

 

3월 16일

중국어가 아니라 한문 번역이 필요할 때가 간혹 있습니다.
뭔가 고전에 나오는 문장을 인용하고 싶은데 원문만 있고 번역문이 없는 경우도 있죠. 이럴 때 바이두나 빙 번역을 사용할 수 있다고 합니다.
국내에서도 고전번역원 한문고전 자동번역 서비스가 있긴 하지만 학습 데이터가 한정적이라 제약이 있다고 합니다. 다만 승정원일기 같은 경우에는 엄청나게 많은 사람 이름이 나오는데 이런 표현에 특화된 학습이 된 것이 아닌가 싶네요. 관련 뉴스를 보면 AI 기반 번역 도입으로 승정원일기 번역 기간을 27년 단축했다는 이야기도 있습니다. 점점 정형화된 글 쓰는 휴먼의 자리는 없어지는 걸까요?

 

 

3월 23일

이번 주 주간 인프런 메일 제목은 "당신도 할 수 있어요, 멋진 글쓰기!"입니다. 뭔가 다이어트 광고 같은 느낌입니다만 조직 구성원들과 함께 공유하면 좋을 내용이네요.
https://inf.run/D8mH
메일리라는 뉴스레터 도구도 소개하고 있는데요. 얼마 전 "35년간의 뉴스레터 운영에서 얻은 경험들"이라는 제목으로 올라온 글도 같이 참고하면 좋을 듯합니다.

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

 

3월 24일

WTD 스탭으로 온라인 콘퍼런스에서 자주 얼굴을 볼 수 있는 Chris Ward가 개인 채널에 인터뷰/리뷰 영상을 올렸습니다. HastyDocs의 CEO Jarek Piotrowski와 CTO Marek Majde와의 인터뷰입니다. 

이 두 사람은 금융 관련 기업(https://www.kontomatik.com/)에서 일하면서 많은 기술 문서가 최신 상태가 아님을 발견(?)하고 시장에서 문서의 최신 상태를 지원하는 도구가 있는지 검토해본 후 시장성이 있다고 판단했다고 합니다. 아무리 잘 만들어진 문서라고 하더라도 코드의 최신 상태를 반영하지 못한다면 좋은 문서가 될 수 없으며 이를 지원해주는 도구가 필요할 것이라는 생각이었습니다. 
기본적인 동작은 문서와 코드에서 특정 단락을 선택하고 링크로 연결한 후 저장소에서 코드를 커밋하면 변경 사항을 주기적으로 확인하고 문서 담당자에게 알림 메시지를 전달해줍니다. 그냥 데모만 보면 저런 기능이 필요한가 싶긴 한데 연결 구조가 1:1이 아닌 경우를 생각하면 유용한 방식입니다. 

 


다만 현재는 여러 제약이 있고 링크를 만들어주어야 한다는 것 자체가 장벽이 되지 않을까 싶긴 합니다. 

인터뷰 영상은 https://youtu.be/1wtK7V-6DMw 에서 볼 수 있습니다. 

- CEO Jarek Piotrowski 가 작성한 소개글 
https://idratherbewriting.com/blog/hastydocs-keep-code-and-docs-updated
- CTO Marek Majde 블로그 
https://marek-majde.medium.com/why-internal-tech-documentation-doesnt-work-ca11c41cdd28
- HastyDocs 
https://www.hastydocs.com/

 

3월 29일

얼마 전 OpenJDK JDK 18이 릴리스 됐습니다. 새롭게 소개된 기능 중 하나가 JavaDoc 에서 코드 작성에 관련된 내용입니다. 기존 방식의 단점을 해결하고 몇 가지 기능을 추가했습니다.
이슈는 2018년에 올라왔는데 2022년에 처리가 되었네요.
https://openjdk.java.net/jeps/413
https://www.javacodegeeks.com/2021/10/jdk-18-code-snippets-in-java-api-documentation.html
기술 문서로 외부에 그대로 공개하기에는 몇 가지 제약 때문에 JavaDoc을 그대로 사용하기보다는 내부적으로 변환해주는 프로세스를 만들고 이를 사용하는 경우가 많습니다. 하지만 JavaDoc을 기반으로 운영하는 조직에서는 도움이 될 듯 합니다.​

728x90