Партнери пишуть у підтримку замість того, щоб читати документацію
Структуруємо документацію за сценаріями: автентифікація, перший запит, типові помилки. Додаємо робочі приклади, які можна скопіювати й запустити.
Документація API, за якою розробники інтегруються без листування з вашою підтримкою
Робимо документацію API і портал розробника: опис методів, приклади коду, пісочницю та швидкий старт. Менше питань у підтримку, швидша інтеграція для партнерів.
Кошторис і строки після брифу
Кому підходить
- SaaS-компанії, які відкривають API для клієнтів і партнерів
- Стартапи, у яких документація живе в одному Notion або в голові розробника
- Продуктові команди, що готують публічний реліз API
- Бізнеси з інтеграціями, де підтримка щодня відповідає на однакові технічні питання
Які задачі вирішуємо
Документація застаріла, бо API змінюється, а текст ні
Генеруємо довідник із специфікації OpenAPI (машинний опис вашого API). Зміни в специфікації автоматично потрапляють на сайт.
У команди немає часу писати тексти, а технічного письменника в штаті немає
ШІ-конвеєр готує чернетку з коду й специфікації. Старший спеціаліст перевіряє кожен розділ і виправляє неточності.
Портал виглядає як звичайний PDF і не вселяє довіри
Робимо окремий сайт із пошуком, версіями API, темною темою та перемикачем мов програмування.
Що входить у роботу
- Аудит наявних матеріалів і специфікації OpenAPI
- Структура порталу: швидкий старт, посібники, довідник, журнал змін
- Довідник методів, згенерований зі специфікації
- Приклади запитів у cURL, JavaScript і Python (інші мови за запитом)
- Опис автентифікації, лімітів, кодів помилок і вебхуків
- Інтерактивна пісочниця для тестових запитів (якщо API має тестове середовище)
- Пошук по документації та версії API
- Налаштування публікації: Docusaurus, Mintlify чи власний сайт, домен, SSL
- Перевірка прикладів реальними запитами до вашого API
- Інструкція для команди, як оновлювати документацію самостійно
Оберіть обсяг роботи
Пакет допомагає описати задачу. Кошторис і строки погоджуємо після брифу та уточнення вимог.
01
Старт
Невеликий API до 20 методів, який треба швидко описати
- Аудит і структура
- Довідник із OpenAPI
- Швидкий старт і автентифікація
- Публікація на вашому домені
02
Портал розробника
Продукт із кількома інтеграціями та зовнішніми партнерами
- Усе зі «Старту»
- Посібники за сценаріями
- Приклади коду у 3 мовах
- Пошук і версіонування
- Журнал змін
03
Портал з пісочницею
Платформа, де інтеграція є частиною продажу
- Усе з «Порталу розробника»
- Інтерактивна пісочниця
- Автоматичне оновлення з CI (автозбірка при змінах коду)
- Вебхуки та SDK-приклади
- Навчання вашої команди
Як працюємо
Бриф і вимоги
Ви описуєте задачу й поточний процес. Уточнюємо вимоги, обираємо перший етап і готуємо кошторис.
Пілот із KPI
Описуємо один ключовий сценарій інтеграції. Домовляємося про вимірюваний показник: наприклад, час першого успішного запиту тестовим розробником.
Чернетка й перевірка
ШІ готує чернетку розділів, спеціаліст вичитує її та запускає кожен приклад проти вашого API.
Публікація
Розгортаємо портал на вашому домені й акаунтах. Усі доступи й файли ваші за погодженими умовами.
Передача команді
Показуємо, як оновлювати специфікацію й сторінки. Оплата йде етапами, за результатом кожного.
Межі роботи
- Не обіцяємо, що підтримка перестане отримувати запитання: ми зменшуємо їх кількість, але не прибираємо повністю
- Не пишемо документацію без доступу до специфікації, тестового середовища або розробника, який відповідає на питання
- Не гарантуємо, що пісочниця працюватиме без тестового середовища: його може знадобитися створити окремо
Часті питання
Що потрібно від нас на старті?
Специфікація OpenAPI або доступ до коду, тестовий ключ API і людина, яка може відповісти на технічні питання. Якщо специфікації немає, можемо її скласти, це окремий етап із власною оцінкою.
Яку платформу ви використовуєте?
Порядок оплати погоджуємо разом із кошторисом до старту. Якщо проєкт має кілька етапів, описуємо результат і умови приймання для кожного. Підтримку та зовнішні сервіси враховуємо окремо.
Чи буде документація англійською?
Так, можемо робити англійську, українську або обидві версії. Для міжнародних партнерів радимо починати з англійської. Переклад оновлень входить у домовленість окремим пунктом.
Як документація не застаріє?
Довідник збирається зі специфікації. Коли ви змінюєте API і оновлюєте специфікацію, сторінки оновлюються. Посібники й приклади треба переглядати вручну, тому ми залишаємо вам короткий чекліст.
Чи може ШІ писати документацію сам?
Ні. ШІ пришвидшує чернетки, але правильність перевіряє людина і запускає приклади. Без цього в тексті з’являються методи, яких не існує.
Скільки це коштує і як платити?
Порядок оплати погоджуємо разом із кошторисом до старту. Якщо проєкт має кілька етапів, описуємо результат і умови приймання для кожного. Підтримку та зовнішні сервіси враховуємо окремо.
Почнемо з вашої задачі
Опишіть бізнес, бажаний результат і поточний процес. Після брифу уточнимо вимоги та підготуємо кошторис.