누구나 웹 서비스의 고급 문서화 지침을 권장 할 수 있습니까?웹 서비스에 대한 문서 표준/구조/스타일
특정 웹 서비스에 대해 모르는 사람이 존재 이유, 로드맵 및 사용 예에 대한 기본적인 이해를 내놓을 수 있도록 해주는 문서입니다.
이러한 문서는 A4/Letter 용지의 두면에 인쇄해야하며 읽는 데 10 분 미만의 시간이 걸릴 수 있습니다.
개발자가 인터페이스를 사용하기 위해 사용하는 저급 API 문서의 보충 사항입니다.
가이드 라인이 확실하지 않지만 웹 서비스 API에 적합한 일련의 문서를 발견 할 수 있습니다.
http://www.flickr.com/services/api/
플리커 API 페이지는 매우 읽을 수있는 형태로 제시되어있다. 이 페이지는 기본적으로 가지고 : 개요 페이지에
특히, 일반적인 액세스 페이지 (사진 업로드, 사진 대체)를 설명하는 페이지는 다음과 같습니다. 나, 중요한. API를 사용하는 사람들에게 공통적 인 일을하는 방법과 사람들이 API를 사용하는 방법을 보여줍니다. 그 마지막 요점은 중요합니다. "이봐 요, 당신은 우리가 이런 식으로 오류 메쏘드를 사용하여 이런 식으로 호출 할 것을 기대합니다"라고 말하고 싶습니다. 사용자에게 API 사용에 대한 몇 가지 모범 사례를 보여주고 전체 지원 요청을 줄일 수 있습니다.
은 Google의 텍스트 상자에 너무 큰 질문 이었습니까? ;) –