Разработка тех. документации

Специфика работы в отделе

Хороший технический писатель обычно выступает переводчиком и разъяснителем для пользователей IT-решениями. Разработчик не всегда может понятно и просто рассказать о том, что он создал – для него всё и так ясно, тогда как технический писатель, находясь между создателем и пользователем, умеет рассказать о сложных вещах доступным языком. При этом стилистика изложения технической документации отличается от художественного повествования – описание сфокусированно, нейтрально, содержит ожидаемую информацию, изложение последовательно. Текст может быть сложным, но мы не используем канцелярский и запутанный язык в описании. Наш пользователь не должен пробиваться к информации через дебри текста.

Источники информации для технического писателя

Технического писателя также можно назвать добытчиком информации. Получить нужные данные для работы можно несколькими способами:

• Из спецификации, которая объясняет назначение продукта и то, как он должен работать. Недостатком спецификаций является то, что зачастую они содержат информацию в несистематизированном виде.
• Из прототипов и ранних версий продукта.
• Из беседы с разработчиками. Это самый главный источник информации для технических писателей: именно девелоперы являются творцами программного продукта, поэтому они в курсе подробностей его функционала и предстоящих изменений в нем.

Поэтому техническому писателю очень важно уметь устанавливать рабочие контакты, быть достаточно дипломатичным в общении и уметь находить компромиссы для решения рабочих задач.

Наш отдел также занимается локализацией текстов, поступающих из наших зарубежных офисов. Как правило, речь идёт о переводе материалов для продвижения и продаж наших продуктов в России.