В то время как адресные темы в API, как правило, заслуживают наибольшее внимание, общим, концептуальным разделам, таким как разделы о начале работы, информация об авторизации, ограничении скорости, кодах состояния и ошибок, кратких справочных руководствах и других темах, уделяется около половины документации.
Такими разделами обычно занимаются технические писатели, а не разработчики.
Оценить качество документации API можно, посмотрев включает ли она такие безадресные темы.
Содержание модуля “Концептуальные разделы”
Разделы руководства пользователя
Требования аутентификации и авторизации
Краткое справочное руководство
Практическое занятие: Оценка концептуального контента в проекте