Александр Михайлов - Профессия Технический писатель, или Рыцари клавиатуры

Для этого нужно открыть один из этих документов и нажать в нем Рецензирование → Сравнить → Сравнить....

Выбрать в окошках Исходный документ и Изменённый документ соответствующие документы.

Откроется следующее окно (результаты сравнения) (рис. 7).

Слева будут перечислены изменения, а над списком изменений будет указано, сколько было внесено изменений (это окно включается/отключается кнопкой Область проверки). Справа вверху — исходный, внизу — изменённый. Эти окна включаются/отключаются кнопкой Сравнить → Исходные документы. По центру — тот документ, который получается при сравнении. В нем можно применять или отклонять правки. (А если целью сравнения было только узнать, какие были внесены правки и какой документ является последней версией, то среднее окно, по сути, не нужно. Смотрим только на правые и делаем выводы.)

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

Рис. 7. Результаты сравнения двух документов в Microsoft Word

Если есть документ, который проверяли два человека одновременно, и у вас появилось две версии этого документа с правками от них, то не нужно сравнивать эти правки вручную. Нужно просто объединить эти документы в один.

Рецензирование → Сравнить → Объединить...

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

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

Одна из главных проблем, которая возникает при использовании соответствующих программ и сервисов для совместной работы, — информационная безопасность. Документация может содержать информацию, составляющую коммерческую или государственную тайну, персональные данные. В этом случае не рекомендуется использовать такие бесплатные сервисы как Google Диск, Microsoft OneDrive и тому подобные, т. к. их владельцы не гарантируют сохранность и нераспространение информации, расположенной на соответствующих виртуальных дисках.

Поэтому для совместной работы рекомендуется использовать либо веб-сервисы, установленные непосредственно на вебсайтах предприятий, либо использовать ПО для совместной работы, которое аккумулирует информацию на локальных серверах компании. Примером таких приложений может служить продукция MadCap Software (инструмент MadCap Flare), Индиго Байт (инструмент Dr. Explain) и другие.

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

Среди программ, ориентированных на создание видеоинструкций, можно отметить следующие: Camtasia Studio, Adobe Captivate, MadCap Mimic и Movavi Video Suite.

В этой теме мы вкратце расскажем о тех областях, в которые может «привести нелёгкая» технического писателя. Причём чем опытнее и профессиональнее техпис становится, тем выше вероятность, что он отойдёт от непосредственной работы с пользовательскими инструкциями на что-то более серьёзное и сложное. Во всех разделах этой обзорной темы мы коснёмся лишь основных моментов, подробный анализ — тема отдельных, весьма объёмных книг и здесь особого смысла не имеет.

В этом разделе мы кратко рассмотрим наиболее популярные стандарты, использующиеся в документировании.

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

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

Существует три основных единых стандарта: программной (ГОСТ 19), конструкторской (ГОСТ 2), технологической (ГОСТ 3) и руководящей (РД) документации. Также применяется ГОСТ 34 — на автоматизированные системы. Ознакомиться с ними подробнее можно в сети Интернет по соответствующим запросам, ибо на каждую область есть свой ГОСТ и на описание управления каждым оборудованием — своя РД. По сути, ГОСТ для техписа — это как таблицы Брадиса для математика — нужно знать как им пользоваться, но заучивать что-то наизусть смысла не имеет — всё необходимое чётко прописано в самом стандарте.

Эти международные стандарты применяются во всём мире, кроме, соответственно, стран, применяющих ГОСТ. Практически вся документация ко всей электронной технике и ПО, разрабатываемая повсюду в мире, исключая руководства для домашних пользователей, выполняется в соответствии с ними. Знание этих стандартов в настоящее время требуется лишь в том случае, если вы работаете в зарубежной компании или планируете переезд за рубеж.