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

Работа с техническим редактором: Получил обратно исправленный текст. И что теперь?

21.06.2013

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


Десять советов как организовать и пережить встречу с техническим редактором

Примечание автора: Эта статья появилась после прочтения и ответа на статью Чери Ласота об авторстве и редактировании художественной и научно-фантастической литературы. Работа с техническим редактором имеет некоторые сходства с другими видами письма, но также и некоторые отличия.

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

1. Выделите на это некоторое время

Если у вас нет времени не торопясь просмотреть комментарии, отложите работу, пока время не появится. Зачем? Если вы торопитесь, то не сможете полностью понять и критически осмыслить что-либо. Комментарии могут показаться резкими или бессмысленными, но помните, что любой редактор имеет личную заинтересованность в создании максимально хорошего конечного продукта. Комментарии не относятся к вам лично, так что не торопитесь и постарайтесь быть объективным. И помните, что иногда редакторам тоже не хватает времени, и с их комментариями может быть весьма непросто.

2. Не перегружайте себя

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

3. Помедлите

Да, вы не ошиблись. После прочтения комментариев от начала до конца отложите работу в сторону, создайте напоминание о ней на какой-либо день, но не раньше, чем через неделю, и вернитесь к ней в намеченный срок. Тяжело отделить себя от работы, и абсолютно естественно вставать на защиту своего творения. Но дополнительное время действительно поможет вам быть объективным. Спустя некоторое время вы сможете вернуться, снова взглянуть на правки и уже сможете сказать (без гнева!), что, да, так действительно стоит изменить, или нет, первоначально было правильно.

4. Пусть ваше сознание само найдет решение

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

5. Делайте копию

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

6. Начинайте с простого

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

— вовлечёт вас в процесс редактирования;

— избавит ваш документ от большого количества пометок;

— очистит путь к более сложному редактированию.

Но если в содержании документа будет большое количество изменений, то, наоборот, оставьте эти «лёгкие» исправления напоследок. Большинство из них могут исчезнуть, если вы будете обновлять или переписывать большие куски материала. Работайте с умом и не тратьте время на исправление текста, который может быть впоследствии удалён.

7. Не только вносите изменения. Учитесь у вашего технического редактора!

Ваш редактор стал редактором, потому что он знает своё дело. Выясняйте, почему он решает внести изменения, которые не вполне ясны вам (да, ИДИТЕ И СПРАШИВАЙТЕ!). Какое основное правило/напутствие? Какова цель? Если вы заметили, что редактор изменил расстановку всех ваших запятых, посмотрите на другие конструкции предложений и поймите, что вы делаете не так. Запомните это правило грамматики. Посмотрите ещё в Руководстве по стилю. Запомните правило и поклянитесь никогда не допускать ту же ошибку снова.

И ещё один момент, незапланированный, но очень приятный: вы начнете получать всё меньше и меньше правок с каждым выученным назубок правилом.

8. Запомните: правки – это советы

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

— каждая правка – опциональна/рекомендуется;

— игнорируйте советы на свой страх и риск.

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

ПРЕДУПРЕЖДЕНИЕ: игнорирование комментария просто потому, что вы подумали он «неправильный» – очень привлекательно. Но не поленитесь посовещаться с техническим редактором, и тогда вы сможете прояснить, корректно или нет то, что он имел в виду. Вы можете быть стеснены временными рамками или сердиться на комментарий, но нет ничего хуже, когда всё пошло в дело после релиза, и потом приходит осознание (когда вы начинается всё прокручивать вспять), что о проблеме сообщалось, но вы предпочли её проигнорировать.

9. Возьмите ещё один отпуск

Когда вы примете все правки, которые смогли, не принеся в жертву свою душу, возьмите ещё один «отпуск». Возьмите ещё один день, но не отсутствуйте слишком долго, потому что у вас ещё есть работа, которую нужно провести над черновиком. Когда вы вернётесь, пройдитесь по тексту снова, проверяя две вещи:

— новые ошибки, которые могли остаться из-за невнимательности (по опыту, MS Word показывает изменения, приводящие к ошибкам, практически всегда!);

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

10. Будьте честны перед собой

Если вы внесли незначительные изменения, значит, вы можете быть свободны, и работа завершена (время для печенек?). Но если вы переписали значительные куски текста и изменили серьёзно структуру, то требуется отнести документ на ещё одну проверку (в идеальном случае, к тому же человеку, но ещё одна пара глаз тоже не помешает).

 

Практические указания по техническому редактированию и рецензированию

Большое примечание к практическим указаниям: если вы относите свой текст больше, чем к одному рецензенту, то следует вносить правки в одну копию документа. Нет ничего хуже, чем работать с несколькими различными вариантами рецензий, каждая из которых содержит похожие (или, хуже, противоречащие друг другу) советы. Существует множество способов это сделать, и вы должны выбрать лучший способ, используя свои инструменты и программы. Если вы отдаёте свой текст одному человеку, а обратно получаете несколько исправленных вариантов, потому что он разослал его другим людям, то вы должны отправить первый документ с правками им обратно и попросить отметить в этом варианте свои комментарии вместо того, чтобы объяснять, как организовать общий доступ между множеством рецензентов. Не допускайте множество рецензий в различных документах. Это может привести к проблемам с вашим начальством, но результат должен заключаться в том, чтобы организовать процесс, который экономит уйму времени (эй, им не нужно было добавлять те 30 комментариев, которые уже кто-то написал? Да, правильно – вы могли сэкономить на 700 долларов времени каждому сотруднику только потому, что они рецензировали один и тот же файл).

Источник: Working with a Technical Editor: Got My Edits Back. Now What?

Тэги: , , ,

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

Облако тегов