Клуб технических писателей

Редактирование внутрь и редактирование наружу

Андрей Пшеничнов
13 мая 2015, 12:19

Коллеги, я с удовольствием посмотрел доклад Максима Ильяхова "Информационный стиль" на Гипербатоне. И с удивлением обнаружил, что редакторский workflow, который описал Максим, течет в противоположную сторону, чем мой. Максим начинает редактуру с самого "мелкого" уровня, от отдельных слов и оборотов. И постепенно движется к структуре, "изнутри наружу". Я - наоборот. Когда я провожу ревью, я обычно начинаю с правки общей структуры материала. Проще говоря - с оглавления. Затем - "внутрь". Когда я могу сконцентрироваться только на чем-то одном - прошерстить формулировки или логичную структуру разделов, я выбираю структуру.

Мне ужасно любопытно, почему так и когда какой подход лучше. 

Объясню свою позицию. Я хочу получить "говорящее" оглавление. Такое, чтобы читатель сразу замапил свой вопрос на нужный раздел, чтобы он сразу выбрал из 5 глав нужную, из 7 разделов выбранной главы нужный. Чтобы это сделать, приходится залезать и в сами разделы, устранять противоречия, которые возникают при изменении структуры. Но это погружение я делаю выборочно, туда, где эти противоречия возникают.

Это моё правило "20-80": на говорящее оглавление я трачу 20% времени и получаю 80% результата. При хорошем оглавлении пользователь точно оказывается в нужном разделе. Да, он потратит время на то, чтобы расшифровать нерафинированный текст. Но он будет уверен, что он приземлился куда нужно, и продраться через текст стоит, ответ на вопрос именно тут. При плохом оглавлении материал будет демотивирующий. Пользователь будет скакать по документу со своим вопросом и читать отлично написанные разделы, которые ему не нужны.

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

 

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

Коллеги, а как обычно редактируете вы? Когда, вы делаете акцент на движении от структуры, когда - от частностей?

 

Андрей Пшеничнов,

ведущий технический писатель

ОАО "ИнфоТеКС"

16 комментариев
Подписаться на комментарии к посту

Андрей, очень интересная тема.

Структура документа — это ни только его "лицо", но и "душа" :)

От того, насколько писатель смог отразить смысл раздела, зависит оперативность работы с данным структурным элементом документа.

Не открою Америки, если скажу, что (несмотря на "типовые" структуры пользовательских документов) руководства пишутся от задач и от функций.

К сожалению, большинство публикаций, стандартов, экспертных мнений апеллируют только к руководствам от функций, но ЭТО не совсем полная картина нашего с Вами "писательского мира" :)

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

Данный выбор определяет и структуру руководства, и его содержание...

Еще: структура документа будет намного четкой и прозрачной, если Вы будете использовать вместо существительных-предметов отглагольные существительные, например, не "Документы", а — "Работа с документами"; не "Таблицы", а — "Действия с таблицами", не "Данные из сторонних источников", а — "Импорт данных" и т. д. Это очень поможет новичку, особенно, если ОН работает с контекстной справкой.

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

Будут вопросы — пишите!

Андрей Пшеничнов
18 мая 2015, 23:18

Спасибо, готов подписаться под всеми вашими рекомендациями)

Про названия разделов с глаголами - особенно.

Рад был помочь.

Кристина
18 мая 2015, 00:28

Скорее всего, воркфлоу, описанный Максимом, отличается от вашего потому, что различаются объемы текстов и их типы. Воркфлоу Максима больше подходит для отдельных веб-страниц, а для большого цельного документа больше подходит ваш воркфлоу.

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

- Для того чтобы распечатать документ...

- Чтобы распечатать документ, который находится в директории...  

- Для печати документа отправленного из юридического отдела... и т. д.

Андрей Пшеничнов
18 мая 2015, 23:17

Насколько я понял Ильяхова он и не обещает что алгоритм будет исправлять стиль глобально. Это просто поисковик его пресловутых стоп-слов.

Как я уже отмечал в теме о глоссарии, использование типовых фигур может сильно облегчить написание, рецензирование, чтение текста и, соответственно, проникновение в него стоп-слов... Я с трудом могу представить как Главред сможет "отрецензировать" проектный документ, например, техзадание... Хотя пример на Гипербатоне был продемонстрирован очень эффектный, за что автору отдельное спасибо!!!

Татьяна Грачёва
18 мая 2015, 13:39

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

Андрей Пшеничнов
18 мая 2015, 23:24

Для меня единственный работающий способ расслоить - это ревью оглавления. Где-то я прочитал, что оглавление должно рассказывать историю. Я добиваюсь, чтобы можно было прочитать оглавление и понять, что в материалах есть, чего нет и где что искать. Когда история получается, слой готов. А дальше - сам текст, тут уже у меня разбить на слои не получается. 

Татьяна Грачёва
19 мая 2015, 10:35

Хороший метод, спасибо! Возьму на заметку.
Где-то также писали, что оглавление для продукта должно быть даже не просто историей, а промо-историей. В идеале такой — чтобы мы прочитали оглавление и захотели купить этот продукт.

Татьяна, не могли бы Вы кратко рассказать как происходит вычитка документа различными экспертами, или Вы читаете одна и далее передаете документ без повторного возвращения... Схема "Рецензент 1 - Рецензент 2 - Автор - Рецензент 1" сильно ставит работу одного сотрудника из цепочки в зависимость от другого. 

Татьяна Грачёва
19 мая 2015, 10:53

У нас сложилась такая схема:

Рецензент = заказчик (проверяем факты) ↔ Автор
    ↓
Технический редактор = коллеги-техписатели (проверяем структуру и логику) ↔ Автор
    ↓
*Литературный редактор / корректор ↔ Автор (только для публичных текстов).

На каждом этапе идет совместная работа с автором до полного согласования.
Зависимость друг от друга при этом, конечно, есть. Но нас это не пугает ))

Татьяна, спасибо за ответ :)

Общение с коллегами только радует.

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

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

Виктор Фигурнов
18 мая 2015, 15:28

Все зависит от того, что входит в компетенцию редактора.

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

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

Андрей Пшеничнов
18 мая 2015, 23:27

Тогда вопрос - в таких заведениях сначала текст отдают редактору структуры или литературному \ техническому \ художественному?

Татьяна Грачёва
19 мая 2015, 10:30

Сначала — главному редактору (чтобы уточнить уместность и посыл текста). Потом литературному редактору (он может переносить куски текста и править формулировки). Корректору, который правит орфографию, пунктуацию и ошибки верстки, — в последнюю очередь (как правило, когда макет уже сверстан).