Технический писатель

Кто мы

IN.TOP — IT-компания, которая развивает технологическую платформу для автоматизации сложных внутренних бизнес-процессов крупного бизнеса. Платформа растёт: больше модулей, сценариев, интеграций и кода — и нам нужен человек, который системно упакует знания о продукте в понятную документацию для команды и клиентов.

Зачем эта роль в нашей компании

Сейчас знания о функциональности нашей платформы распределены по разработчикам, аналитикам, задачам и чатам. Новые сотрудники (РП, бизнес-инженеры, аналитики) тратят много времени на поиск информации, а изменения сложно отслеживать. Мы хотим собрать единый, живой и поддерживаемый источник правды: Wiki по платформе и модулям.

Чем предстоит заниматься

1) Построить систему документации (с нуля или переупорядочить существующую):

• структура Wiki: платформа → модули → бизнес-сценарии → роли/рабочие места → интеграции → настройки/права → FAQ;

• единые шаблоны страниц (описание функции, сценарий, входы/выходы, статусы, бизнес-правила, ошибки, интеграции, ограничения).

2) Описывать функциональность понятным языком для разных аудиторий:

• для внутренних ролей: руководители проектов, бизнес-инженеры, аналитики, внедрение, поддержка;

• частично — для клиентов (админ-гайд, пользовательские инструкции, справка, релиз-ноты).

3) Добывать знания из команды и превращать их в документацию:

• интервью с разработчиками/аналитиками/продактами, разбор требований, тикетов, макетов;

• фиксация договорённостей, терминов, глоссария.

4) Документация по интеграциям и API (если применимо):

• описание интеграционных сценариев, форматов, справочников, ролей и прав;

• работа со Swagger/OpenAPI (или аналогами) совместно с командой.

5) Поддержка актуальности:

• процесс обновления документации под релизы;

• понятные «Definition of Done» для документации: что обязано появляться в Wiki при выпуске функционала.

Что считаем результатом (ожидания на 2–3 месяца)

• создана логичная структура Wiki + шаблоны страниц;

• описаны ключевые модули/сквозные сценарии (ТОП-20–30 самых используемых);

• есть глоссарий и «карта платформы» (архитектурный обзор на уровне продукта);

• запущен процесс обновления документации под релизы (ответственные, правила, чек-лист).

Требования (обязательные)

• опыт техписателем/писателем продуктовой документации в IT от 2 лет (желательно B2B / enterprise / платформенные продукты);

• умение писать структурно: сценарии, статусы, бизнес-правила, роли, таблицы, схемы;

• навык быстро разбираться в незнакомой системе и задавать правильные вопросы;

• опыт работы с инструментами документации: Confluence / Notion / GitBook / аналог, Markdown;

• внимательность к деталям, единая терминология, аккуратность и системность;

• умение выстраивать процесс: собрал информацию → согласовал → опубликовал → поддерживаешь актуальность.

Будет плюсом

• опыт с BPMN/UML, диаграммами (Miro, draw.io и т.п.);

• опыт описания API / интеграций / событийных моделей;

• базовое понимание SDLC, Jira/Tracker, Git (на уровне «понимаю, как жить рядом»);

• английский для чтения документации и терминов.

Как мы работаем

• тесное взаимодействие с продактом, аналитиками и разработкой;

• доступ к требованиям/тикетам/макетам/демо;

• документация — часть производственного процесса, а не “доп. активность по остаточному принципу”.

Условия

• формат: офис / гибрид / удалённо (как вам удобно — на ваш выбор);

• конкурентная фикс-оплата (готовы обсуждать по уровню);

• сильное влияние на продукт: вы создаёте “единую правду” о платформе;

Этапы отбора

Короткое знакомство (20–30 мин).

Практическое задание (небольшое и приближенное к реальности).

Финальное интервью с руководителем направления / продукта.

Пример тестового (вариант): по демо или описанию фичи сделать 1–2 страницы Wiki по шаблону: «назначение», «кто пользуется», «сценарий», «поля/статусы», «права», «ошибки/краевые случаи», «интеграции», «FAQ».