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

Суть роли

Ведение и актуализация базы знаний по продукту ФармЭксперт: превращение задач от экспертов и реализованных доработок в понятные, структурированные и машиночитаемые статьи.

Обязанности

• Актуализировать базу знаний по задачам от экспертов (точная формулировка «что изменить/добавить/убрать» приходит от них) и по автозадачам на реализованные тикеты.
• Проверять описываемый функционал в служебной программе по ходу написания — статья пишется с одновременным выполнением действий и подтверждением их корректности.
• Редактировать черновики, подготовленные нейронкой, до состояния публикации (факт, структура, язык).
• Держать структуру: одна тема — одна статья, без дублей и частичных пересечений, с перекрёстными ссылками на смежные статьи.
• Контролировать уровень абстракции: в пользовательской инструкции — интерфейс, логика, настройки; без структуры БД и кода.
• Назначать корректный уровень доступа статьи (публичная / для пользователей ФХ / внутренняя) .

Требования

• Краткость и ясность: писать простым языком, без воды.
• Умеет декомпозировать сложный процесс на смысловые единицы до написания текста.
• Единая терминология, расшифровка терминов при первом упоминании.
• Готовность разбираться в функционале программы и проверять каждое утверждение на практике.
• Внимание к структуре и полноте, а не к объёму.

Что не надо делать

• Тестировать фичу «работает ли она» — это делает QA; ваша проверка касается достоверности того, что вы описываете.
• Писать каждую статью с нуля — черновик готовит нейронка, вы верифицируете и доводите.