Как разработчик/поставщик SDK, я предполагаю что писать в документации и как должна выглядеть документация по SDK. Неизбежные разделы, которые приходят на ум:
- ссылка на весь класс (со свойствами, методами и т. д.)
- примеры кода для каждого метода
- инструкции по использованию с фрагментами кода
- примеры процедур и приложений, позволяющие программисту быстро приступить к работе
- ????
Если вы хотите конкретизировать язык, я ориентируюсь на разработчиков C#, и мой SDK состоит из небольшого набора классов, поэтому документация в ответах должна быть аналогичной. MSDN, DevExpress, Ogre — просто примеры того, чего я не хочу ставить в пример, потому что в них много человеко-дней, и тем не менее они великолепны.
Подробнее здесь: https://stackoverflow.com/questions/412 ... umentation