Я технический писатель: беру сырые исходники и превращаю их в документацию, на которую можно опереться и инженеру, и рядовому пользователю. В работу иду от вашего кода, пул-реквестов, коллекций 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
— Правка, перестройка структуры и стайлгайд для существующих документов
