티스토리 뷰

5월 4일

디앤디에서 진행하는 'B2B 국문 테크니컬 커뮤니케이션 공개 교육' 안내입니다. 6월 2일 하루 진행되는 교육이구요. 오랜만에 오프라인으로 진행됩니다. 'B2B'라는 문구는 크게 신경 쓰지 않아도 됩니다.
B2B 국문 테크니컬 커뮤니케이션 공개 교육

비슷한 내용으로 TTA에서 6월 20일부터 3일간 테크니컬 라이팅 교육이 진행될 예정입니다(이건 5월 23일부터 등록이네요). 강사가 같은지는 모르겠습니다. 예전에는 장현아 대표가 직접 진행했는데 요즘에는 다른 강사를 보내기도 하더라구요.
2022년 제1차 SW 글로벌화를 위한 국‧영문 B2B 테크니컬 라이팅 교육

5월 11일

어제(5/10) 출간된 신간 소개입니다. '구글 엔지니어는 이렇게 일한다 Software Engineering at Google'라는 책이구요. 구글 테크니컬 라이터가 같이 쓰고 리뷰한 글이라 중간중간 테크니컬 라이터와의 협업이나 구글 내 정보 관리 등에 대한 이야기가 등장합니다.
구글 엔지니어는 이렇게 일한다

그중에서 10장 문서자료(Documentation) 중 일부를 남겨봅니다(나머지는 책을 구입해서 보세요 ^^)


테크니컬 라이터가 필요한 순간(When Do You Need Technical Writers?)

구글이 아직 젊고 빠르게 성장하던 시기에는 소프트웨어 엔지니어링 테크니컬 라이터가 부족했습니다 (지금도 마찬가지입니다). 그리고 중요하다고 생각되는 프로젝트에는 팀에 정말 필요한지와 상관없이 테크니컬 라이터를 배정하는 경향이 있었습니다. 그렇게 한 밑바탕에는 테크니컬 라이터가 팀의 문서 작성과 관리 부담을 덜어줘서 프로젝트의 속도를 높여주리라는 기대가 깔려 있었습니다. 결국은 잘못된 가정으로 판명났습니다.
구글은 엔지니어링팀 대다수가 팀에 필요한 문서자료를 스스로 완벽하게 작성할 수 있음을 깨달았습니다. 다른 이의 도움이 필요한 경우는 오직 팀원 외 독자를 위한 문서를 작성할 때뿐이었습니다. 외부 독자용 문서 작성은 어렵기 때문이죠. 팀 안에서는 피드백 루프가 아주 기민하고, 도메인 지식과 가정도 명확하며, 무엇을 요구하는지도 더 분명합니다. 물론 문법이나 구조잡기 측면에서는 테크니컬 라이터가 더 뛰어난 경우가 많습니다. 하지만 희소하고 특화된 자원인 테크니컬 라이터를 팀 하나를 지원하는 데 투입하는 건 최선이 아니었습니다. 확장성이 낮기 때문이죠. 실제로도 조직을 잘못된 방향으로 이끌었습니다. 중요하다고 인정받은 프로젝트의 소프트웨어 엔지니어들은 문서를 작성할 필요가 없어졌습니다. 그리고 엔지니어들을 문서작성에서 멀어지게 함으로써 기대하던 효과와 반대의 결과가 나왔습니다.
테크니컬 라이터는 희소하기 때문에 소프트웨어 엔지니어들이 일반적인 업무로 취급하지 않는 일에 집중해야 합니다. 예컨대 API 경계를 넘나드는 문서 작성이 여기 속합니다. Foo 프로젝트팀은 Foo 프로젝트에 필요한 문서자료가 무엇인지를 명확하게 알고 있을 것입니다. 하지만 Bar 프로젝트에 무엇이 필요한지는 잘 모를 가능성이 크죠. 테크니컬 라이터는 도메인에 익숙하지 않은 사람을 더 잘 대변할 수 있습니다. 그래서 테크니컬 라이터의 핵심 역할 하나가 바로 프로젝트가 어디에 유용한가에 관한 팀 내 가정에 의문을 품어보는 것입니다. 많은 혹은 대부분의 소프트웨어 엔지니어링 테크니컬 라이터가 이러한 특정 유형의 API 문서자료에 집중하는 이유가 여기 있습니다.

 

5월 13일

NHN Cloud에서 요즘 한참 테크니컬 라이터를 모집하고 있던데 지난주에 이런 인터뷰 기사도 올라왔었네요.

https://blog.naver.com/nhntoast/222720468990

 

업[業]터뷰 in NHN Cloud #1. IT와 사람을 글로 잇다: NHN Cloud 테크니컬 라이터 (Technical Writer) 유영경

4월 1일 독립 법인으로 출범한 NHN Cloud! 이제 막 닻을 올려 더 넓은 세상으로의 항해를 시작했는데요...

blog.naver.com

 

어제 구글 I/O 2022 키노트에서 구글 문서에서 작성한 콘텐츠를 자동 요약해주는 기능을 선보였습니다. 이제 글을 쓰면 AI가 잘 정리할 수 있는지에 따라 글의 품질이 결정되지 않을까 하는 불안함이 밀려오네요. 일관성이 없다든지 앞뒤가 맞지 않는 글이라면 AI가 빨간줄을 막 그어대지 않을까 싶다는.
https://youtu.be/nP-nMZpLM1A?t=756

좀 더 기술적인 내용은 지난 3월 Google AI 블로그에 올라온 글을 참고하시구요.

https://ai.googleblog.com/2022/03/auto-generated-summaries-in-google-docs.html

 

Auto-generated Summaries in Google Docs

Posted by Mohammad Saleh, Software Engineer, Google Research, Brain Team and Anjuli Kannan, Software Engineer, Google Docs For many of us...

ai.googleblog.com

 

5월 16일

SaaS형 모니터링 서비스를 제공하는 와탭 랩스에서 URL 모니터링 서비스를 무료로 전환했습니다. uptimerobot 무료 플랜을 사용했는데 와탭 URL 모니터링은 uptimerobot 유료 플랜과 비슷한 수준의 서비스를 제공합니다.
자체적으로 서비스 장애를 모니터링하고 있는 것이 아니고 문서 관련 서버를 직접 챙겨야 한다면 유용한 서비스입니다.

https://www.whatap.io/ko/blog/109/

 

URL 모니터링, 이제 무료로 사용하세요! | 와탭 블로그

와탭 URL 모니터링을 요금 걱정 없이 무제한으로 사용하실 수 있습니다!

www.whatap.io

가이드 문서에는 10개까지만 지원한다고 되어 있는데 10개 이상도 등록할 수 있습니다. 5월 1일 변경된 정책이 문서에는 아직 반영되지 못한 모양입니다 ㅠㅠ

https://guide.whatap.io/whatap_guide/use_guide/url_monitoring/pages/intro.html

 

URL 모니터링이란? :: WhaTap

WhaTap URL Monitoring Guide 와탭 URL 모니터링은 최종 사용자 입장에서의 웹 사이트 접속 정상 여부를 판단하기 위한 용도의 서비스를 제공합니다. 사용자 입장에서 웹 사이트의 정상 접근 여부를 브라

guide.whatap.io

 

5월 17일

아마도 작년 10월 즈음에 공개된 보고서입니다. 한국어 번역이 이제 올라온 건지 아님 그동안 못 봤던 건지 우연히 발견을 했네요.
보고서의 주요 내용 중 하나가 '문서화'에 대한 내용인데요.

우수한 문서화 관행은 DevOps 기능을 성공적으로 구현하기 위한 기초입니다.
Good documentation is foundational for successfully implementing DevOps capabilities.

 

짧지만 '문서 품질을 개선하는 방법'에 대한 내용이 담겨 있습니다.

https://cloud.google.com/resources/state-of-devops?hl=ko 

 

Accelerate State of DevOps 2021  |  Google Cloud

귀하의 조직과 우수한 기업을 비교할 수 있도록 성공적인 소프트웨어 배포와 운영 성능을 향상하는 방법을 살펴봅니다.

cloud.google.com

 

5월 24일

GitHub에서 마크다운 코드 작성 시 수학식을 추가하는 기능을 지원한다고 합니다. 관련 요구사항은 2014년 올라온 건인데 뭔가 보안적인 이슈 때문에 지원을 하지 못하고 있다는 답변이었습니다. 그리고 8년이 지나 갑자기(?) 지원을 시작했네요.

https://github.blog/2022-05-19-math-support-in-markdown/

 

Math support in Markdown | The GitHub Blog

We are pleased to announce that math expressions can now be rendered natively in Markdown on GitHub

github.blog

MathJax에서 문제를 해결해서 그런 건지 아님 내부적으로 보완책을 만든 것인지는 알 수 없습니다.
흥미롭게도 2010년 GitHub에서 MathJax을 채택했다는 뉴스도 찾아볼 수 있습니다. 위키에서 마크다운을 지원한다는 소식과 함께였습니다. "지금은맞고그때는틀리다"였을까요 ^^

https://www.mathjax.org/github-chooses-mathjax-for-math-support/

 

GitHub Chooses MathJax For Math Support

Software development project hosting sevice GitHub announced last week that its new wiki system uses MathJax to provide math support. The new wiki is called gollum and you can read their post for more information on the release.

www.mathjax.org

 

5월 30일

라인 사내 용어 사전 개발 이야기입니다. Mtg를 meeting이라고 사용한다고 해서 뭐지 싶었는데 다른 곳에서도 많이 쓰는 약어라고 합니다. 앞으로 다국어 이슈나 다른 의미로 사용되는 용어에 대한 처리 등을 어떻게 해나갈지 궁금해지네요.

https://engineering.linecorp.com/ko/blog/glossary-project-line-words-open/

 

사내 용어 사전, LINE Words 오픈 여정기 - LINE ENGINEERING

안녕하세요. LINE에서 근무하고 있는 테크니컬 라이터 강정일입니다. 혹시, MTG라는 말을 들어본 적 있으신가요? Google에서 검색해 보니 매직 더 개더링(Magic: The Gathering)이라는 게임이 제일 먼저 나

engineering.linecorp.com

 

5월 31일

어제 공유한 라인 용어 사전 개발 이야기중에 위키에 작성한 내용을 헤드리스 CMS인 LandPress Content로 옮긴다는 이야기가 있었습니다. 요즘 자주 등장하는 용어라 헤드리스 CMS를 정리해볼까 싶어 자료를 찾다가 어도비 용어집에 정의된 내용을 찾았습니다.

설명 중

가끔 정적 사이트는 헤드리스 CMS 기능을 소개하기 위한 데모 용도로 사용됩니다.

라는 문구가 있어서 이제 드림위버는 더 이상 팔지 않는 건가라는 생각이 들었습니다(어차피 구독형이 대부분이라 따로 드림위버 패키지만 구입하는 경우는 극히 드물겠지만 개발을 중단하지는 않았네요).

https://business.adobe.com/kr/glossary/headless-cms.html

 

 

오픈소스 컨트리뷰톤 멘토링 행사 중 문서화, 번역이 '참가자 모집 유형'에 포함된 목록입니다.
오픈소스 프로젝트에 문서화라는 역할로 어떤 식으로 참여해야 하는지 어려워했다면 좋은 기회가 되지 않을까 싶네요.
7월부터 10월까지 이어지는 일정입니다.
(각 프로젝트마다 문서화만 전담하는 것인지 코드 기여도 필요한 것인지는 상세 내용을 참고하세요).

 

소프트웨어 문서 작업을 자동화하는 소프트웨어를 개발하는 스타트업 Mintlify의 투자 유치 소식입니다. 
https://techcrunch.com/2022/05/30/mintlify-taps-ai-to-automatically-generate-documentation-from-code/
코드에서 주석을 자동으로 생성해주는 도구는 꽤 많이 나와있는데요. 그중에서도 Mintlify Doc Writer는 작년 12월 공개 이후 꽤 긍정적인 평가를 받고 있는 듯합니다.
https://marketplace.visualstudio.com/items?itemName=mintlify.document
문서화 관리 플랫폼인 Mintlify는 오래되고 업데이트되지 않는 문서에 대한 관리를 지원해주는 솔루션입니다. 이 분야 역시 많은 이들이 고민하고 비즈니스로 만들고자 하는 분야이죠.
https://www.mintlify.com/

댓글
댓글쓰기 폼