Блог технического писателя Ильи Жукова

Как вычитать свой текст: инструкция для автора

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

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

Закончив со структурой, я перехожу к вычитке текста. Чтобы самостоятельно вычитать свой текст и сделать это качественно, я использую методику двойной вычитки (вычитка текста в электронном формате и на бумаге). Далее расскажу, что и в каком порядке я делаю. Описание будет в виде инструкции. Вы можете скопировать её, адаптировать под себя и использовать как чек-лист.

 

Инструкция для автора

Чтобы вычитать свой текст, выполните следующие действия.

  1. Сделайте паузу перед вычиткой.

Отложите текст на сутки. Минимально – на час. Смените деятельность: пройдитесь, выпейте кофе, сделайте разминку и т.п. Главное – отвлечься от текста.

  1. Создайте рабочую обстановку.

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

  1. Сформулируйте задачи вычитки.

Составьте список того, что необходимо найти и исправить. Например:

 
  • Лишние пробелы.
  • Некорректное форматирование.
  • Опечатки.
  • Орфографические и пунктуационные ошибки.
  • Большие абзацы.
  • Длинные и сложные предложения.
  • Пассивный залог.
  • Обратный порядок слов.
  • Повторы однокоренных слов.

 

  1. Выгрузите текст в текстовый редактор.

Для вычитки текста я предпочитаю MS Word 2010 + ОРФО. Если текст подготовлен в текстовом редакторе, пропустите данный шаг.

  1. Настройте текстовый редактор.
 
  • Включите отображение непечатных символов.
  • Задайте язык для всего текста.
  • Включите проверку правописания.

 

  1. Измените тип и размер шрифта.

Если использовался шрифт с засечками (например, Times New Roman), выберите шрифт без засечек (например, Arial). Это поможет победить эффект замыливания глаз.

  1. Удалите лишние пробелы.

Используйте функцию автозамены. Замените два пробела на один, «пробел точку» на «точку» и т.д. Всё, что останется после автозамены, доделаете во время вычитки в электронном формате. Если вы не используете стили и задаете положение текста при помощи пробелов, удалять лишние пробелы придется руками.

  1. Проверьте текст в электронном формате.

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

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

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

  1. Распечатайте текст и прочитайте его вслух еще раз.

Проверьте еще раз всё, что проверяли в электронном формате. Не расслабляйтесь! Большая часть работы уже сделана, но я уверен, что вы найдете, над чем поработать.

  1. Внесите изменения в исходник.

Некоторые изменения проще внести сразу, некоторые – после текстового редактора. Делайте, как удобнее.

 

Ответы на вопросы

  1. Зачем менять тип и размер шрифта? Что это за фокусы?

Чтобы победить эффект замыливания глаз, нужно изменить восприятие текста. Тип и размер шрифта — это контекст восприятия. Можно также изменить цвет текста, цвет фона, поля, ориентацию страницы и т.д. Чтобы получить более подробную информацию по этой теме, смотрите понятие рефрейминга в теории НЛП.

  1. Для чего нужна первая вычитка в электронном формате? Можно ведь сразу работать с распечатанным текстом.

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

  1. Для чего нужна вычитка на бумаге? Мы же только что вычитали весь текст.

Распечатка текста — ещё один способ изменить контекст восприятия. Считается, что с бумаги замечаешь на 30% больше ошибок.

  1. Почему бы не вычитать текст в третий раз?

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

 

Добавить комментарий

Последние статьи

Поиск в WebHelp находит удаленные раздел…

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

Читать полностью...

Контекстная справка в приложениях Window…

Понятие контекстной или контекстно-зависимой справки (от англ. context-sensitive help) появилось в 1987 году с выходом формата WinHelp. Изначально контекстная справка ...

Читать полностью...

Как поддерживать скриншоты в актуальном …

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

Читать полностью...

Книга «Разработка технической документац…

Уважаемые коллеги! Если вам нужно быстро освоить разработку документации по ГОСТ, рекомендую обратить внимание на книгу В.А. Глаголева «Разработка технической документ...

Читать полностью...

Перевод выходных документов в Help and M…

Выбрав русский язык и русскую кодировку в настройках проекта Help and Manual, многие авторы после первой сборки удивляются, увидев в выходных документах английские сло...

Читать полностью...

Размер и расположение окна CHM при перво…

Разработчик справки в формате CHM может задать размер и расположение окна, которые будут использоваться при первом запуске CHM-файла. После того, как пользователь пере...

Читать полностью...

Рваные края скриншотов в Help and Manual

Многие платные редакторы скриншотов, например, SnagIt, FastStone Capture и др., умеют создавать эффект рваных краев. В сети Интернет можно найти множество видеоуроков ...

Читать полностью...
новое в Help and Manual 9

Новое в Help and Manual 9

23 ноября 2022 года компания EC Software к 25-летнему юбилею выпустила 9-ю версию программного комплекса Help and Manual (выходит c 1997 года). Комплект шаблонов Premi...

Читать полностью...

Создание CHM-справки в бесплатной програ…

KEL CHM Creator — это «новая» хорошо забытая программа, выпущенная в 2012 году, предназначенная для создания и декомпиляции CHM-файлов. Программа не требовательна к ре...

Читать полностью...

KEL CHM Creator — бесплатная программа д…

Если вам нужно создать CHM-файл, и вы больше не хотите пользоваться глючной программой HTML Help Workshop, тогда KEL CHM Creator — это ваш вариант. Программа позволяет...

Читать полностью...
ключевые слова

Ключевые слова в Help+Manual

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

Читать полностью...

HTML Help Workshop – бесплатная программ…

В 1997 году Microsoft выпустила новый формат справки, HTML Help (CHM), а также бесплатную программу для создания и редактирования справки в этом формате — HTML Help Wo...

Читать полностью...

HelpNDoc — бесплатная альтернатива Help+…

Еще одной альтернативой RoboHelp и Help&Manual является программа HelpNDoc от французского разработчика, компании IBE Software. Это практически полный аналог HelpS...

Читать полностью...

HelpSmith — достойная альтернатива Help+…

Продолжая тему средств разработки справки и пользовательской документации, нельзя не рассказать о программе HelpSmith. Она работает по принципу единого источника и под...

Читать полностью...
отечественная программа для разработки справки

Dr.Explain — отечественная программа для…

За почти 30-летнюю историю существования RoboHelp и Help&Manual стали стандартом средств разработки справки и пользовательской документации в среде Windows. Сегодн...

Читать полностью...
качество текста

Как повысить качество текста инструкций

Каждый автор знает: во время написания и правки текста глаз замыливается. Смотришь в текст и читаешь не то, что написано, а то, что хочешь видеть. В этой статье я расс...

Читать полностью...

Все о справке и документации для пользователей!

Следить за новыми статьями:

© Илья Жуков, 2019-2023. Охраняется законом об авторском праве.