June 13, 2012 · Philosophy SDK

Documenting API's

I have been involved in writing some guidelines on how to document API's so that they look uniform across the product. The challenge here is that i am suppose to arrive that for any language through which the SDK exposes the API's (C++, C#) for example. Here is what i arrived at.

They are language and technology agnostic. The techniques that solves them in the respective language shall be described in later sections.

Comments powered by Disqus