Технічний письменник: документація, API-довідники, керівництва

Я технічний письменник і перетворюю розрізнені матеріали в документацію, якій довіряють і розробники, й звичайні користувачі. Працюю безпосередньо з вашим кодом, pull request-ами, колекціями 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
— Редагування, реструктуризація й стайлгайд для готової документації