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