Всё для технического документирования
+7 (495) 001-40-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Основы: роль технического редактора

17.06.2013

01Вы – писатель, работающий с техническим редактором? Если да, считайте, что вы счастливчик; многие технические писатели не имеют такой роскоши, как услуги редактора. Писатели, работающие в проектной группе, часто редактируют документы друг друга, тогда как у их коллег, работающих в одиночку, может не быть другого выбора, кроме как выверять свою работу самостоятельно. Хотя эти сценарии широко распространены, они не являются примером для подражания.

Писать и редактировать – это разные процессы; каждый требует свой набор навыков и имеет свой принцип. Некоторые управленцы не до конца понимают разницу между написанием текста и  его редактированием, не осознают, какую пользу может принести редактор как отдельный сотрудник. По мнению Каролин Руд (Carolyn Rude) и Энджелы Итон (Angela Eaton), соавторов «Технического редактирования», технический редактор – это эксперт по коммуникациям, языку и нуждам аудитории. Хороший редактор способен оценить картину в целом так же хорошо, как и мелкие детали, и может играть ключевую роль в проектах по документированию.

Обязанности технического редактора

Из чего же состоит работа технического редактора? Как утверждают Руд и Итон, существуют три уровня редактирования:

— Полное редактирование: просмотр и правка как контента (на полноту, точность и стиль языка), так и форму (на структуру, визуальный дизайн и удобство восприятия) текста.

Корректура opyediting): проверка, что документ «механически» правильный (орфография, пунктуация и грамматика) и стилистически верный.

Вычитка (Proofreading): сравнение финальной версии документа с исправленной версией, чтобы убедиться, что все исправления были внесены.

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

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

Масштаб действий технического редактора меняется от проекта к проекту в зависимости от потребностей клиента. Некоторые редакторы могут быть вовлечены в управление проектом, тестирование удобства использования и составление руководств по стилю. Обязанности редактора также варьируются в зависимости от того, являются ли они постоянными сотрудниками или фрилансерами. Штатные сотрудники, как правило, более вовлечены в ежедневную деятельность компании и могут работать теснее с другими участниками команды проектов по документированию.

Вкратце, технические редакторы ответственны за качество информации. Причём это тройная ответственность: перед читателем, писателем и клиентом или организацией, для которой они работают.

Помощь читателю

Первоочередная цель технического редактора – читатель. Редактор выступает как помощник читателя. Чтобы удовлетворить его, редактор должен приложить все усилия и взглянуть на материал с его точки зрения. Первое, на что редактор должен обратить внимание – цель документа: зачем документ нужен читателю, и как тот будет его использовать? Цель документа определяет необходимый уровень редактирования и количество времени, затраченного редактором.

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

Технические редакторы также играют важную роль в обеспечении удобства использования документа. Чтобы определить, является ли информация полной, редактор должен поставить себя на место читателя и предвидеть вопросы, которые читатель задаст себе при изучении чего-то нового. Также редакторы могут помочь читателю в изучении новых задач, проверив порядок действий на ясность и логическую последовательность.

Другой важный для технических редакторов пункт – анализ аудитории, который включает в себя:

— Фоновые знания и опыт;

— Характеристики (возраст, способности к чтению, занятость);

— Окружение (используемое оборудование и программное обеспечение, прямое либо удаленное подключение);

— Культурные ожидания и ценности (национальные, профессиональные и корпоративные).

Мы склонны думать, что анализ аудитории – это задача писателя. Но техническому редактору также необходимо принимать во внимание данные об аудитории при оценке документа.

Вне зависимости от целевой аудитории технические редакторы всегда должны брать в расчет некоторые важные пункты. Главный из них – безопасность использования информации из документов. В Соединенных Штатах и ??других странах процедура включает в себя предупреждения и требования о соблюдении законодательства. Доступность также является одним из ключевых направлений. При оценке формы и содержания документа редактор должен убедиться, что он отвечает потребностям людей с ограниченными физическими возможностями и способностями к чтению. С учетом мирового рынка редактор должен также рассматривать локализацию. Редакторы должны уметь предвидеть проблемы, которые могут возникнуть при переводе, например, двусмысленные формулировки или необходимость дополнительных полей, и при работе с документацией по мере необходимости изменять стиль письма и оформление, упрощая их.

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

Работа с писателями

Технические редакторы и писатели работают совместно для достижения следующей цели: создание вычищенных документов и руководств, которые помогают и обучают читателя. Нижеследующие советы могут помочь редакторам поддерживать успешные рабочие отношения с писателями.

Подготовка

— Попробуйте втянуться в проект с самого начала. Это позволит вам влиять на процесс с начального этапа и предупредить серьёзные структурные проблемы.

— Задайте для проекта (лучше в письменной форме) уровень редактирования, которому будете следовать

— Ознакомьтесь с тематикой проекта, чтобы иметь возможность правильно оценивать документ и не надоедать экспертам простейшими вопросами. Если тематика сложна, назначьте встречу с экспертом.

— Найдите список литературы, в которой упоминается тематика проекта, найдите соответствующие словари и руководства по стилю.

Редактирование

— Избегайте навязывания своего стиля писателям. Не производите изменения, если они не касаются восприятия формулировок, грамматики или организации.

— Убедитесь, что вы не изменяете замысел автора.

— Не полагайтесь только на свои инстинкты, чтобы решить, что корректно, а что нет; дважды проверяйте свои предположения по достоверным источникам.

— Предоставьте писателю достаточно времени для исправления отредактированной версии перед наступлением окончательного срока. Разбивайте большие документы на несколько частей, чтобы писатель мог обрабатывать одну часть за раз, ответил на ваши комментарии и привык к вашему стилю редактирования.

Коммуникации

— Будьте тактичны, когда оставляете комментарии или вносите правки. Используйте позитивные категории, такие как «предлагаю» или «улучшить».

— Посещайте заседания, где происходят доклады о ходе работы и задавайте при необходимости вопросы.

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

Работа для клиентов и организаций

Работа технических редакторов имеет много аспектов. Но в первую очередь они всегда должны следовать потребностям людей, которые их нанимают. В большинстве проектов в редактировании документов участвует множество людей (по желанию или по назначению), и редактор должен знать, кого из них консультировать на каждом этапе процесса. Перед тем, как начать новый проект, редактор должен спросить: «Кто здесь босс?» – или более аккуратно: «Кто контролирует работу редактора?» Это может быть руководитель, менеджер, эксперт или сам редактор.

Многие проекты проводятся в жёстких условиях, когда большая ставка может делаться на решения технических редакторов. Среди таких условий могут быть:

— Конечные сроки проекта;

— Бюджет и такие ресурсы компании, как сотрудники и оборудование;

— Необходимость достичь совместимости с уже существующими документами, корпоративным стилем и эргономичностью;

— Соответствие стандартам, политикам и законодательству;

— Технические факторы (например, скорость загрузки сайта).

02Выводы

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

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

Источник: Foundations: The Role of the Technical Editor

Тэги: , ,

< Вернуться к списку публикаций

Облако тегов