티스토리 뷰

Fabrizio Ferri Benedetti는 Splunk에서 테크니컬 라이터로 일하고 있습니다. 링크드인 프로필을 보면 테크니컬 라이터와 함께 API 디자이너라고 자신을 소개하고 있습니다. 이번 세션의 주제는 일반적으로 엔지니어의 영역이라고 생각하던 API 디자인을 테크니컬 라이터가 어떤 식으로 참여하고 주도할 수 있는지 그리고 왜 테크니컬 라이터가 API 디자인에 강점을 가지는지를 설명합니다.

이 분 프로필 옆에 스피커 아이콘이 있는데요. 처음 보는 거라 확인해보니 자신의 이름 발음을 녹음하고 이를 방문자가 들을 수 있도록 하는 것이라고 합니다. 흔히 사용하지 않은 이름이라면 발음을 어떻게 해야 하는지 애매할 수 있는데 꽤 유용한 기능이네요. 관련 설명을 보면 데스크탑에서는 편집 기능을 제공하지 않고 모바일 앱에서만 녹음해서 등록할 수 있다고 합니다.

https://www.linkedin.com/help/linkedin/answer/123728/-?lang=ko 

 

API라는 것을 들여다보면 시스템과 사용자 또는 시스템과 시스템과의 커뮤니케이션이죠. 그리고 이러한 커뮤니케이션에 특화된 능력이 필요한 사람들이 바로 테크니컬 라이터입니다.

API 디자인과 테크니컬 라이팅의 공통점은 사용하는 핵심 도구에 있다고 합니다. 바로 word입니다. API 디자인은 코드 아니야라고 생각할 수 있는데, 물론 문서 없이 코드를 먼저 작성할 수도 있겠지만 대부분 문서를 작성하고 이를 기반으로 코드 작업을 진행합니다. 이 문서에는 어떤 식으로 커뮤니케이션을 할 것인가를 정의합니다. 기술적인 내용이 아니구요. 때문에 커뮤니케이션 전문가로서 테크니컬 라이터가 API 디자인에 참여할 수 있다는 주장입니다.

물론 이미 디자인된 API를 문서화하는 것과 API를 디자인하는 것 사이에는 차이가 있습니다. 다루어야 하는 일의 범위도 차이가 있지요. 하지만 테크니컬 라이터로서 한 번 정도는 도전해볼만한 자리가 아닐까 싶습니다.

https://twitter.com/writethedocs/status/1445014631395860481

 

728x90
반응형
댓글
댓글쓰기 폼