Feeds:
댓글

Posts Tagged ‘api documents’

www.programmableweb.com 에 게재된 Article을 소개 합니다.

API 사업 발전에 있어서 가장 중요한 개발자에게 어떻게 시선을 맞출지에 대한 얘기 입니다.

저자는 Flickr(사진공유) , Twilio (음성전화,문자) API Doucments 를 예로 들어 설명하고 있습니다.

 

[ API Console / API Browser / API Explorer ]

Image

API를 보급(?)하기 위하여 개발자가 쉽게 API를 이해하고 개발에 사용할 수 있는 대화형 API Console을 언급합니다. 물론 코드를 바로 따서 쓰는 구조도 갖고 있어야 하겠죠.

이 기능은 모든 개발자가 매우 선호하는 방식이며, 주렁주렁 달린 설명보다 효과적임을 강조하고 있습니다. (포스팅 하며 살펴보니 Flickr는 App Garden 이라고 활용사례 위주로 대체된듯 합니다.)

 

[ API Examples – 비즈니스 단위로 단계적 설명 필요 ]

Image

API를 쉽게 개발자에게 이해시키기 위한 방법으로 비즈니스적 접근을 강조합니다.

음성전화,SMS API 설명하기 위한 전화받기, 걸기, 문자 보내고 받기 등등으로 실제로 개발자가 원하는 업무 단위를 중심으로 Documents를 작성할 것을 권고하고 있습니다.

같은 관점에저 Flickr API 설명을 보니 Upload Photo 만 보이는 군요.  세부적인 사진검색, 인증 등은 덜 돋보이도록 배치되어 있습니다.

 

[API 사업 발전과 신뢰]

API 사업의 발전을 위해서는 API와 개발자간의 신뢰가 구축되어야 하며, 사업 담당자는 API Documents에서 정확한 기능을 제시하고 가능한 것과 안되는 것의 명확한 제시를 유지해야 함을 강조하고 있습니다.  물론 세부적인 설명도 필수 이겠지요.

개발자(API 사업관점에서는 파트너)에게 친숙한 샘플 App과 Toubleshooting, Sample codes등도 상호 신뢰를 구축하기 위한 좋은 도구로 제시되고 있습니다.

시사점 : 고객의 눈높이에서 항상 고민하고 Best Practice 를 항상 살펴보자~~~

 

원   문 : http://blog.programmableweb.com/2012/01/09/more-partners-less-effort-api-documentation-for-the-win/

번역본 : http://forum.withapi.com/?document_srl=3921

Read Full Post »