Swapnil Ogale는 Redocly 테크니컬 라이터 애드보케이트입니다.
(이번 행사는 유난히 애드보게이트라는 직함이 많네요. 유행인 건가 ㅠㅠ)
https://redoc.ly/ 는 API 문서화 서비스를 제공합니다. 국내 개발 관련 글에서도 자주 등장하는 서비스입니다.
Putting the "tech" in technical writer
이 분은 2006년부터 다양한 분야에서 테크니컬 라이터로 일했다고 합니다. 소프트웨어 엔지니어링뿐 아니라 금융, 스타트업에서도 함께한 경력을 가지고 있죠. 그런데 작년 어느 테크 회사에 인터뷰를 잘 마치고 뭐 이 정도면 되겠지 싶었는데 아래와 같이 거절 메일이 왔다고 합니다.
뭐 크게 충격받을 내용은 아니지만, 자신의 커리어가 단지 코딩 스킬 때문에 밀려버렸다는 것에 충격을 받았나 봅니다. 사실 테크니컬 라이터는 기술 콘셉트를 이해하고 기술팀과 협력할 수 있고 코드를 해석하는 정도면 충분한데, 코딩 경험을 이야기하고 있으니 답답했나 봅니다.
그리고 Redocly에 들어갔나 보네요.
하여간 그래서 주변을 돌아보니 테크니컬 라이터 중에 "tech"에 너무 무심한 사람들이 많아 이런 건 좀 알아두면 좋겠다 싶어 만든 세션입니다.
전통적인 방식과 다르게 테크니컬 라이터의 작업도 개발과 같은 도구와 프로세스를 사용하는 DOCS-AS-CODE에 대해 개념 정도를 이해하고 한번 정도 관련 도구들을 사용해보자 뭐 이런 내용입니다.
WTD 슬랙에서도 "Docs as Code" 채널은 인기 있는 채널입니다. 올라오는 글을 보면 너무 기술적으로 깊이 들어가는 내용들이라 WTD 사이트에 있는 내용 정도만 살펴보면 좋을 듯하네요.
https://www.writethedocs.org/guide/docs-as-code/
Docs as Code — Write the Docs
Docs as Code Documentation as Code (Docs as Code) refers to a philosophy that you should be writing documentation with the same tools as code: Issue Trackers Version Control (Git) Plain Text Markup (Markdown, reStructuredText, Asciidoc) Code Reviews Automa
www.writethedocs.org
어디든 마찬가지지만 개발자라고 해서 내가 배운 개발 환경을 다른 곳에서도 쓸 수 있는 건 아닙니다. 새로운 환경에서는 그에 맞게 배울 것이 생기죠. 조직에서 새로운 멤버가 얼마나 쉽게 적응할 수 있도록 하는 건 또 별개의 이야기라~
텍스트 편집기도 요즘에는 거의 실시간으로 미리보기를 지원하고 있어서 WYSIWYG와 크게 다르지 않습니다. 예전처럼 텍스트만 가지고 편집하는 건 아니니 그렇게 거부감은 없어 보입니다. 다만 워드에서 화려하게 사용했던 장식이나 스타일, 레이아웃 등을 쓸 수 없는 것이 조금 답답할 수 있습니다. 조직에서 이건 좀 워드처럼 만들어봐라고 한다면 플러그인을 쓴다든지 일이 복잡해질 수 있어서 가능하다면 간결한 그대로의 상태를 유지하는 것을 권장합니다.
