Каждую концептуальную тему этого модуля мы анализировали в контексте выбранного опен-сорс проекта. Теперь расширим свой анализ, чтобы увидеть, как безадресные темы отображены на других сайтах документации API. Помните, что иногда лучший способ научиться создавать документацию API - это внимательно наблюдать за тем, как это делается на сайтах, которыми вы восхищаетесь. Следуя стандартным практикам в отрасли, можно создавать более предсказуемые и понятные шаблоны в собственной документации.
👨💻 Оценка концептуального контента 3 сайтов API документации
-
Переходим к Списку 100 сайтов API документации и выбираем 3 сайта для анализа. Можно взять сайты любимых инструментов или любимых компаний, или просто 3 рандомных сайта.
-
Смотрим документацию и анализируем ее состав:
| Безадресные разделы | Сайт 1 | Сайт 2 | Сайт 3 |
|---|---|---|---|
| Обзор API | __ | __ | __ |
| Начало работы | __ | __ | __ |
| Аутентификация и авторизация | __ | __ | __ |
| Коды ошибок и статусы | __ | __ | __ |
| Ограничения скорости | __ | __ | __ |
| Примеры кода и руководства | __ | __ | __ |
| SDK и примеры приложений | __ | __ | __ |
| Краткое справочное руководство | __ | __ | __ |
| API глоссарий | __ | __ | __ |
| Лучшие практики | __ | __ | __ |
Создаем такую таблицу в своем любимом текстовом редакторе и заполняем по возможности все столбцы.
- Появились какие-либо заслуживающие внимания наблюдения из анализа?