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

Компания EngExp занимается разработкой технической документации, написанием инструкций и созданием мануалов.

Основные языки, на которых мы пишем — это русский и английский. Документация и инструкции требуются для программ, сайтов, интернет-сервисов, мобильных приложений. При необходимости документация может быть написана одновременно на русском и английском языке.

С нашей помощью документация создается с самого начала или дорабатывается существующая.

Мы разрабатываем документацию для программ под MacOS, Windows, Linux, Android, iOS. При необходимости наши специалисты переработают устаревшие справочники помощи, допишут текстовую информацию, сделают новые скриншоты, обновят стиль и отформатируют данные. Текстовая справочная информация проверяется квалифицированными специалистами по языку.

Обновления и сопровождение документации

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

Если документация живёт в Git или вы планируете связать её с пайплайном разработки, смотрите также раздел Doc-as-code и DocOps.

Мы создаём

• Руководства и инструкции пользователя.
• Справочные системы к программным продуктам.
• Статьи с описанием сервисов и ПО.
• Вики (wiki).
• Рубрики «Вопрос-ответ» (FAQ).

Возможно ли привлекать сторонние организации для разработки хелпа?

Никому не дано знать программные продукты так, как их разработчикам. Возможно ли стороннему техническому писателю в совершенстве изучить все тонкости продукта? Конечно. А то, что техническому писателю в начале работы не известно об особенностях продукта — это большое преимущество. Он смотрит на программный продукт, сайт или мобильное приложение с разных сторон и получает полное представление о том, как его описать и преподнести пользователям. Кроме того, в процессе изучения продукта, эксперт может обнаружить ошибки и подсказать, как улучшить интерфейс.