Описание услуги
Я технический писатель и превращаю разрозненные материалы в документацию, которой доверяют и разработчики, и обычные пользователи. Работаю напрямую с вашим кодом, пул-реквестами, коллекциями Postman, перепиской в мессенджерах и короткими созвонами с инженерами, а на выходе выдаю чистый структурированный текст, который объясняет не только что делает функция, но и зачем и когда её применять. Мой профиль — документация для разработчиков, справочники по API, руководства по интеграции, пользовательские и административные инструкции, статьи формата how-to. Точность для меня на первом месте: каждый эндпоинт, параметр, код ответа и текст ошибки я сверяю с реальным продуктом до публикации, чтобы читатель не наткнулся на шаг, который молча не работает.
Вы получаете не просто вычитанный текст. Я продумываю структуру: что уходит в быстрый старт, а что — в справочник, пишу в едином тоне и оформляю переиспользуемый стайлгайд. Отдаю в Markdown, reStructuredText, AsciiDoc или прямо в ваш docs-as-code пайплайн, свободно работаю с Git, спецификациями OpenAPI и Swagger, генераторами статических сайтов и инструментами для диаграмм. Добавляю прокомментированные примеры кода, образцы запросов и ответов, диаграммы последовательностей и скриншоты там, где они действительно нужны, и держу всё под версионированием, чтобы обновления давались легко.
Запускаете ли вы публичный API, вводите новый SDK или наконец описываете внутренний инструмент, который живёт в голове одного инженера, — я оценю объём, соберу требования у заинтересованных сторон и сдам цельный комплект документации в срок. Пришлите, что есть, и я честно скажу, чего не хватает и как закрыть пробелы.
— Документация для разработчиков и гайды по быстрому старту
— Справочники REST и GraphQL API из спецификаций OpenAPI/Swagger
— Руководства пользователя, админ-гайды и статьи how-to
— Docs-as-code в Markdown, reST или AsciiDoc с Git
— Редактура, реструктуризация и стайлгайд для готовой документации
Вы получаете не просто вычитанный текст. Я продумываю структуру: что уходит в быстрый старт, а что — в справочник, пишу в едином тоне и оформляю переиспользуемый стайлгайд. Отдаю в Markdown, reStructuredText, AsciiDoc или прямо в ваш docs-as-code пайплайн, свободно работаю с Git, спецификациями OpenAPI и Swagger, генераторами статических сайтов и инструментами для диаграмм. Добавляю прокомментированные примеры кода, образцы запросов и ответов, диаграммы последовательностей и скриншоты там, где они действительно нужны, и держу всё под версионированием, чтобы обновления давались легко.
Запускаете ли вы публичный API, вводите новый SDK или наконец описываете внутренний инструмент, который живёт в голове одного инженера, — я оценю объём, соберу требования у заинтересованных сторон и сдам цельный комплект документации в срок. Пришлите, что есть, и я честно скажу, чего не хватает и как закрыть пробелы.
— Документация для разработчиков и гайды по быстрому старту
— Справочники REST и GraphQL API из спецификаций OpenAPI/Swagger
— Руководства пользователя, админ-гайды и статьи how-to
— Docs-as-code в Markdown, reST или AsciiDoc с Git
— Редактура, реструктуризация и стайлгайд для готовой документации
