Я ищу примеры компаний, которые отлично разбираются в документации API. Flickr выглядит очень красиво. Любые рекомендации?
Для меня очевидно, что существуют разные определения того, что такое "отличная документация API". Я ищу примеры, которые сочетают приятный дизайн и удобство использования с обширной и точной документацией.
До сих пор Flickr и Last.fm охватывали эти аспекты больше всего. Я могу открыть их и сразу узнать, что и как распознать информацию, которую я ищу.
Я должен признать, что MSDN не так уж плохо.
Библиотека MSDN для .NET Framework - это, вероятно, лучшая документация по API, о которой я знаю.
Мне нравится то, что вы можете найти почти для каждого метода перегрузку полный образец кода, который показывает, как использовать API. Это даже верно для не так используемых методов, например, ILGenerator.Emit, например. Вы получаете подписи и образцы кода на разных языках .NET(С++ CLI, VB.NET, С#, иногда F #), плюс ценные замечания.
Обратите внимание, что библиотека .NET MSDN также содержит много страниц о концепциях, руководствах, инструкциях и т.д.
Например, здесь вы можете найти целый набор ссылок, которые объясняют, что такое отражение, и как использовать эту часть фреймворка в более высокий уровень. Он объясняет идеи и концепции в отношении простого использования API: типы времени выполнения, способы обработки типичных типов, безопасность, метаданные и т.д.
Только несколько проектов, фреймворков и инструментов, которые я знаю, имеют такую подробную документацию.
Документация по Java также является первоклассной.
jQuery имеет отличную документацию.
У консенсуса есть last.fm также хорошая документация.
Документация Qt является моей любимой.
Django довольно впечатляет.
Дает хороший учебник "Начало работы", который является обязательным, но также имеет очень доступную документацию, когда вам нужна дополнительная информация.
Карты Google не так уж плохи.
Да, flickr хорошо документирован. last.fm находится в том же духе.