Профиль навыка

API Documentation Writing

Документация API: OpenAPI/Swagger, Redoc, примеры запросов, code samples

Документация Техническая документация

Ролей

3

где встречается этот навык

Грейдов

5

сформированная дорожка роста

Обязательных требований

5

ещё 10 — необязательные

Домен

Документация

Группа

Техническая документация

Последнее обновление

17.03.2026

Как использовать

Выберите текущий грейд и сравните ожидания. Карточки ниже покажут, что нужно закрыть для следующего уровня.

Чего ждут на каждом уровне

Таблица показывает, как меняется глубина владения навыком от Junior до Principal.

Роль Обязательность Описание
Blockchain Developer Документирует REST и RPC endpoints для взаимодействия с блокчейн-нодой. Использует OpenAPI для описания API и включает примеры запросов и ответов в формате JSON для основных операций.
Game Designer Документирует простые игровые системы: описывает параметры механик, таблицы баланса, правила взаимодействий. Создаёт базовые Game Design Documents (GDD) с описанием core loop и основных фич. Использует шаблоны для структурирования документации.
Technical Writer Обязателен Понимает принципы написания developer-friendly API-описаний: ясность, полнота, примеры использования. Знает разницу между reference docs и conceptual guides. Умеет писать описания параметров и полей в понятном стиле.
Роль Обязательность Описание
Blockchain Developer Создаёт подробную документацию для blockchain API: описывает модели данных, коды ошибок, rate limits и WebSocket-подписки. Интегрирует автогенерацию документации из кода через Swagger/Redoc.
Game Designer Создаёт подробную техническую документацию для игровых систем: описание API событий, структуры данных баланса, протоколы взаимодействия клиент-сервер. Пишет спецификации для интеграции с внешними SDK (аналитика, монетизация). Документирует параметры конфигурации для live-ops.
Technical Writer Обязателен Пишет полноценные API-гайды: quickstart, authentication flow, error handling, use cases. Создаёт code samples на нескольких языках (curl, Python, JavaScript, Go). Следит за consistency терминологии и стиля во всех разделах API docs.
Роль Обязательность Описание
Blockchain Developer Проектирует документацию для платформенного blockchain API: changelog, versioning, migration guides. Обеспечивает консистентность терминологии и примеров для внешних и внутренних потребителей.
Game Designer Проектирует структуру технической документации для всего игрового проекта. Создаёт living documents, которые автоматически обновляются при изменении конфигов. Документирует сложные системы: экономику, progression, meta-game. Пишет технические спецификации для cross-team взаимодействия.
Technical Writer Обязателен Создаёт продвинутый контент для API-документации: migration guides между версиями, architecture overviews, best practices. Разрабатывает style guide для API-описаний. Проводит UX-ревью документации с позиции developer experience.
Роль Обязательность Описание
Blockchain Developer Определяет стандарты документирования API для blockchain-организации. Внедряет docs-as-code подход и review-процесс для технической документации. Координирует работу технических писателей.
Game Designer Определяет стандарты документирования игровых систем для всей студии. Формирует шаблоны GDD, технических спецификаций, balance sheets. Внедряет процессы ревью документации и knowledge sharing между командами. Обеспечивает актуальность документации на протяжении жизненного цикла проекта.
Technical Writer Обязателен Выстраивает систему контент-стратегии для API-документации на уровне продукта: content types, audience mapping, content lifecycle. Координирует работу писателей и разработчиков. Внедряет user feedback loop для непрерывного улучшения документации.
Роль Обязательность Описание
Blockchain Developer Формирует стратегию developer experience на уровне организации. Определяет подходы к публичной документации, SDK-гайдам и developer onboarding для blockchain-платформы.
Game Designer Формирует культуру документирования на уровне организации. Определяет enterprise-стандарты технической документации для портфолио игровых проектов. Оценивает и внедряет инструменты автоматизации документации: Confluence, Notion, custom wiki. Создаёт методологию передачи знаний между проектами студии.
Technical Writer Обязателен Определяет стандарты технического письма для API-документации в масштабе компании. Формирует подходы к multi-audience documentation (internal devs, partners, public). Исследует и внедряет лучшие практики из ведущих developer portal (Stripe, Twilio, GitHub).

Сообщество

👁 Следить ✏️ Предложить изменение Войдите, чтобы предлагать изменения
📋 Предложения
Пока нет предложений для API Documentation Writing
Загрузка комментариев...