티스토리 뷰

Scot marvin이 쓴 글을 읽을 때는 몰랐는데 북미 쪽에서 테크니컬 라이터의 지위 또는 일자리가 넉넉치 않나 봅니다. 전통적인 매뉴얼 시장이 아무래도 축소되고 있어서 새로운 시장을 찾아야 하는 위기가 다가오고 있어서 아마도 이번 특집이 마련된 것이 아닌가 싶습니다.

2014/10/30 - [인사이드TW] - API 문서화는 누가 하나요?


Mary Conner의 글은 이런 점을 솔직하게 드러내고 있습니다. 제목부터가 'How Do You Break into API Documentation?'으로 테크니컬 라이터가 API 문서화라는 새로운 시장에 어떻게 진입할 수 있는지에 대한 가이드입니다.


아직은 시장이 블루오션이라 기존 매뉴얼 작업 대비 1.5~2배 정도 시간 당 수익을 낼 수 있다고 하네요. 원격에서 일할 수 있는 기회도 많다고 하는데 아마 국내와 다르게 글로벌 기업 프로젝트의 경우에는 어짜피 한군데서 개발을 하는 것이 아니기 때문에 문서화 작업 역시 원격에서 일하는 것도 가능하다는 의미가 아닌가 싶습니다. 물론 혹 서부 지역으로 출근해야 한다면 그 비싼 임대료 등을 감당해야 하기 때문에 2배 수익이라는 것이 실질적으로 이득이 될 지는 좀 더 고민해야 할 수도 있습니다.


문서화라고 해서 단지 기술적인 이슈를 풀어서 서술하는 것뿐 아니라 전체 문서화 프로세스에 참여하는 것을 포함하고 있습니다. 오브젝트 네이밍이라든지 문서 구조화, 경쟁 제품 분석, 직관성 있는 가이드 등이 포함되어 있죠. 그렇게 하기 위해서는 여러 가지 미션을 뛰어 넘어야 합니다.


내용 중에 TTFHW 라는 표현이 있었는데 문서에 있어서 사용자 경험을 가장 잘 표현해주는 말이 아닌가 싶습니다.

...you will look for ways to improve TTFHW (Time to First "Hello World"), ...


다른 글에서도 TTFHW 라는 표현을 찾아볼 수 있습니다.

What makes an open api great

http://manfredbo.tumblr.com/post/59515293423/what-makes-an-open-api-great

Three Ways to Decrease Time to First Hello World

https://sendgrid.com/blog/three-ways-to-decrease-time-to-first-hello-world/


http://www.blog.juliaferraioli.com/2014/05/hierarchy-of-developer-needs.html


다른 분야도 마찬가지겠지만 API 문서화는 어느 정도 프로그래밍 경험을 필요로 합니다. 직접 코드를 짤 필요는 없지만 어느 정도 알아야 한다는 것이 큰 함정입니다. 이 글에서는 이에 대해 멋진 설명을 해주고 있네요.


...If you are interested in the API career path, strike the word "training" from your consciousness and substitute the word "studying," because the culture of code development is one of unceasing self-education. Even when developers nominally finish training courses on new languages and methodologies, they know that they are never done researching and improving their grasp of the material, which itself will never stop mutating into new versions and forms...


흔히 코드를 무술 수련에 많이 비유하는 이유도 이런 배경이 아닌가 싶습니다. 오래 전에 정리된 지식을 공부하는 것이 아니라 기본기를 배우고 이를 응용하면서 수련하는 과정이 필요하고 그렇기 때문에 테크니컬 라이터가 이 길에 들어서는 것이 쉽지 않다는 겁니다. 오히려 개발자가 글쓰기를 배워서 옮기는 것이 더 쉽게 느껴지겠죠.


요즘에는 온라인으로 코드를 배울 수 있는 여러 길이 있지만 창의적인 발상력을 키우기 위해서라면 나쁘지 않은 선택입니다. 하지만 자신의 직업으로 API 문서화를 하려고 한다면 길고 긴 수련이 기다리고 있다는 충고도 아끼지 않고 있습니다.


음 제목 보고 낚였는데 왠지 이번 특집은 테크니컬 라이터의 새로운 밥줄 찾기 시리즈가 아닌가 싶네요.

신고
댓글
댓글쓰기 폼