Ищу технического писателя для переработки документации нашего API. Сейчас всё, что есть у партнёров — это разрозненные заметки разработчиков, устаревший файл в облаке и десятки одинаковых вопросов в переписке каждую неделю: как передать параметр, какой формат у ответа, что означает тот или иной код ошибки. Хочу получить один связный документ, который закроет эти вопросы раз и навсегда.
По каждому методу API нужно раскрыть: назначение, полный список параметров с типами, обязательностью и значениями по умолчанию, порядок авторизации запроса и перечень возможных ошибок с пояснением, из-за чего они возникают. Нужны рабочие примеры — запрос и ответ в JSON, построенные на данных, близких к реальным, а не на условных «foo» и «bar». Отдельным блоком — страница с песочницей: партнёр вводит свой ключ доступа, собирает запрос через форму и сразу видит ответ сервера.
Готов дать тестовый доступ к API, скинуть внутренние черновики и созвониться с разработчиками бэкенда, чтобы снять вопросы по нестандартным методам. Важен опыт именно с техдокументацией для API — понимание REST, форматов передачи данных и распространённых схем авторизации. При отклике приложите пару похожих работ и назовите примерный срок.
Кратко, что должно получиться на выходе:
— полное описание методов, параметров и кодов ошибок
— примеры запросов и ответов в JSON
— интерактивная песочница для тестирования запросов
— инструкция для подключения новых партнёров
По каждому методу API нужно раскрыть: назначение, полный список параметров с типами, обязательностью и значениями по умолчанию, порядок авторизации запроса и перечень возможных ошибок с пояснением, из-за чего они возникают. Нужны рабочие примеры — запрос и ответ в JSON, построенные на данных, близких к реальным, а не на условных «foo» и «bar». Отдельным блоком — страница с песочницей: партнёр вводит свой ключ доступа, собирает запрос через форму и сразу видит ответ сервера.
Готов дать тестовый доступ к API, скинуть внутренние черновики и созвониться с разработчиками бэкенда, чтобы снять вопросы по нестандартным методам. Важен опыт именно с техдокументацией для API — понимание REST, форматов передачи данных и распространённых схем авторизации. При отклике приложите пару похожих работ и назовите примерный срок.
Кратко, что должно получиться на выходе:
— полное описание методов, параметров и кодов ошибок
— примеры запросов и ответов в JSON
— интерактивная песочница для тестирования запросов
— инструкция для подключения новых партнёров
