Профессия "Технический писатель", или "Рыцари клавиатуры" | страница 9

Поясним на примере. Некая фирма решила облегчить жизнь владельцам бензоколонок, собрав все их возможные функции (заправка, мини-гостиница на 1-2 номера, столовая, туалет, магазин необходимых мелочей и т. д.) в единую систему учёта и управления. Для этого требуется разработка как технической, так и программной части. В этом случае аналитик начинает длительное и полное исследование предметной области: общается с потенциальными клиентами, владельцами заправок, выясняет их потребности, проводит опросы среди дальнобойщиков и шофёров, которые наиболее активно пользуются услугами многофункциональных заправок, анализирует уже имеющиеся системы подобного рода, если они существуют, ищет в них слабые места, которые можно улучшить. Когда все сведения собраны, а на это может потребоваться много времени, он выдаёт их своему руководству и разработчикам в понятной для тех форме. По результатам этого исследования принимается решение о целесообразности создания такой системы и, если смысл в ней есть, отдел разработки приступает к её реализации.

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

1. Полное документирование программного продукта или оборудования. Если вы работаете в небольшой компании, то вам достаётся, как правило, целиком и полностью две задачи: составление пользовательской документации и составление руководства администратора / сервисного инженера. Этих двух документов (иногда ещё требуется набор бумаг по ГОСТ для сдачи продукта в эксплуатацию по государственному заказу) хватает для «бумажного» сопровождения большинства изделий и программ. Иногда требуется написать только одно из этих руководств, поскольку одни программы не имеют пользователей, а другие — администраторов. Например:

• IM-клиент — стационарное приложение для одного рабочего места, оно не имеет администратора, есть только конечный пользователь, которому и нужна инструкция;

• сетевой антивирус — он присутствует на компьютере пользователя, но управление антивирусной сетью осуществляется с консоли управления, доступ к которой имеет только администратор сети. Сами пользователи в этом случае не могут либо вообще ничего, либо могут совершить два-три простейших действия, за остальным же придётся обращаться к администратору;