• IM-клиент — стационарное приложение для одного рабочего места, оно не имеет администратора, есть только конечный пользователь, которому и нужна инструкция;
• сетевой антивирус — он присутствует на компьютере пользователя, но управление антивирусной сетью осуществляется с консоли управления, доступ к которой имеет только администратор сети. Сами пользователи в этом случае не могут либо вообще ничего, либо могут совершить два-три простейших действия, за остальным же придётся обращаться к администратору;
• крупное корпоративное приложение — у этого вида ПО есть и пользователи со значительным перечнем возможных действий, и администраторы, отвечающие за поддержание работы системы в целом и её настройку.
Зачастую необходимость самостоятельно документировать всё, что нужно, продиктована тем, что кроме вас технических писателей в компании нет.
2. Документирование частей или компонентов продукта.Если вы работаете в крупной организации, то, скорее всего, делаете только часть работы по документированию, поскольку описать продукт целиком в одиночку не по силам никому. В таком случае вы описываете только определённые компоненты крупного программного комплекса или некоторые из входящих в его состав приложений. Остальные материалы пишутся вашими коллегами — во многих крупных компаниях есть целые отделы документирования или, как минимум, несколько не собранных в единое подразделение технических писателей, выполняющих одну крупную общую задачу. В качестве примера можно привести MS Office и другие программные комплексы его уровня — для описания таких пакетов требуется труд нескольких квалифицированных сотрудников.
Кроме этих основных, есть ещё длинный перечень дополнительных обязанностей, которые возникают в той или иной ситуации:
1. Создание технических статей и обзоров для СМИ(техническое описание производимого компанией продукта, его сильных сторон и недостатков), материалов рекламного характера, где первичная цель — «расхвалить» продукт, попутно показав его техническую начинку.
2. Написание аналитических статей.Эти материалы также пишутся для СМИ с целью продвижения продукта, но в них говорится не только о продукте вашей компании, но и о похожих разработках конкурентов. В такой статье вам потребуется объективно и беспристрастно по ряду параметров сравнить ваше изделие или программу с другими аналогичными продуктами. Известны случаи, когда такие статьи не доходили до публикации из-за неприятного вывода: у соседа-то лучше!
3. Подготовка репортажей.Если представитель вашей компании выступал на какой-либо выставке или конференции, то вполне вероятно, что готовить отчёт будете вы, а не маркетолог.
4. Разработка внутренней документации.Иногда требуется сделать описание внутренних регламентов, ролей сотрудников компании, написать для них инструкции. Такие задачи возникают не часто и больше используются для «затыкания дыр» в рабочем времени при невысокой нагрузке на техписа по основным задачам.
5. Составление технических заданий.В зависимости от цели технического задания, которое предстоит написать — формальная сдача его в государственные органы или использование в качестве прикладной «инструкции по разработке программы», будут отличаться и методы его подготовки. В первом случае делается формальный, строго соответствующий ГОСТ документ, в котором отражён некий необходимый минимум требований к новому продукту. Во втором случае вы тщательно прописываете все требования и нюансы, не особо обращая внимания на внешний вид документа, поскольку никуда из отдела разработки он не выйдет.
6. Создание презентационных материалов.К ним относится разработка пресс-релизов, создание презентаций для выступлений на конференциях или размещения в СМИ, а также подготовка информационных брошюр и рекламных буклетов.
7. Переводы.Сюда относится как локализация иноязычных текстов (например, из головного офиса совместной компании, расположенного за рубежом), так и написание материалов на других языках для предоставления иностранным клиентам, если главный офис компании находится в России. Стоит отметить, что во втором случае необходимый уровень владения иностранным языком должен быть значительно выше, чем в первом.
8. Видеопрезентации.В последнее время все большую популярность получают озвученные видеоруководства и видеометариалы, представляющие собой презентацию компании и её продуктов. Поскольку изготовление видео на заказ стоит достаточно дорого, вполне возможно, что эту задачу отдадут техническому писателю как самому «близкому по профилю» сотруднику.
Читать дальше