Оформите запрос на демонстрацию системы

Мы свяжемся с вами в течение одного рабочего дня, чтобы определить ваши потребности и удобный формат демонстрации системы DIRECTUM:

Заказать демонстрацию

По вопросам выбора и приобретения:
present@directum.ru
+7 (341) 272-11-00

Вверх
@DIRECTUMCompany:   Пожалуйста, подождите, загружаем данные из twitter...

Кто такой технический писатель?

В России официально пока нет такой профессии. И в ВУЗах не обучают по этой специальности. Однако спрос на этих специалистов неуклонно растет и многократно превышает предложение. Задумайтесь, раньше технических писателей не было вообще, а теперь они нужны почти каждой IT-компании.

Если у вас есть высшее техническое или лингвистическое образование, вы можете попробовать себя в этой профессии.

Как же пишется техническая документация на программный продукт? Откуда писатель знает, что нужно писать. Попытаемся разобраться вместе.

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

Узнав о программном продукте все что можно и нельзя, нужно рассказать об этом доступным языком, т.е. выступить в роли переводчика между программистом и конечным пользователем. Для этого писатель должен встать на место конечного пользователя программы: разложить всю информацию «по полочкам», продумать структуру текста, обдумать, какая информация нужна пользователю, а какая – нет.

Дальше переходим собственно к написанию текста. Для того чтобы написать техническую документацию, не нужно обладать выдающимися литературными способностями. Главная задача – текст должен быть понятным. При написании текста нужно строить простые предложения, использовать стандартные фразы и следовать корпоративным стандартам оформления. Это все нужно для того, чтобы тексты, написанные разными писателями, имели как можно меньше отличий. Почему не должно быть отличий? Потому что писателей в организации может быть 1, 2 или 100, а читатель один. Если все 100 будут писать по своему, представляете, каково будет это читать?

Тексты написаны. Что дальше? А дальше нужно их внимательно прочитать несколько раз и отправить на согласование рецензентам. Рецензенты выскажут свои замечания. Задача писателя исправить или аргументированно отказать по замечанию (рецензент не всегда прав). Здесь главное не затянуть процесс. Вести обсуждения можно бесконечно, нужно уметь вовремя остановиться.

Теперь осталось только собрать итоговые файлы справки и настроить контекстный вызов (чтобы в каждом месте программы по клавише F1 вызывалась соответствующая статья справки). Тут нет ничего сложного – за вас все сделает специальная программа для сборки документации.

Вот так и происходит подготовка технической документации. Но этим не ограничивается круг обязанностей технического писателя. Мы постоянно расширяем кругозор, рассматриваем новые форматы и способы оформления документации, изучаем все новые и новые корпоративные продукты, помогаем в разработке и оформлении внутренней документации. Подробнее о том, чем еще занимается технический писатель, написано в блоге Загадочная профессия - технический писатель.

Документация – важная часть программного продукта, зачастую по ней оценивают и сам продукт. Именно от технического писателя зависит, каким будет это впечатление.

Кнопка
связи