Основы создания руководств в Word - неудачные примеры и как их исправить

Инструкции по эксплуатации, регламенты работ, порядок технического обслуживания, внутренние руководства по эксплуатации. В таких документах со временем начинает сказываться не столько качество текста само по себе, сколько то, используете ли вы Word как «инструмент для подгонки внешнего вида».

Способы, которые поначалу кажутся быстрыми:

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

Если эти приёмы накапливаются, документ ломается при каждой правке.

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

Оглавление

1. Сначала вывод
2. Не превращать Word в инструмент ручной подгонки
3. Сводная таблица неудачных паттернов и лучших практик
4. Ключевые моменты на практике
5. Минимальный шаблон Word для руководств
6. Проверка перед распространением
7. Итог

1. Сначала вывод

Сначала перечислим только выводы. В создании руководства значение имеют эти четыре пункта.

1. Поручить структуру функциям Word Заголовки, нумерацию, оглавление, ссылки и управление страницами нужно поддерживать не вручную, а через стили, поля и разрывы Word.

2. Не поручать выравнивание пробельным символам Пробелы, многократные Tab и пустые строки ломаются при каждой последующей правке. Используйте параметры абзаца, отступы, таблицы и разделы.

3. Не смешивать рецензирование с основным текстом Указания по правкам должны идти через комментарии и запись исправлений, а не через красный текст в теле документа. Тогда становится ясно, что именно зафиксировано в финальной версии.

4. Обновлять автоматические элементы непосредственно перед распространением Оглавление, номера страниц, перекрёстные ссылки и номера рисунков и таблиц обновляются все разом в самом конце. Перед созданием PDF также стоит проверить доступность.

2. Не превращать Word в инструмент ручной подгонки

Самое важное в создании руководства - разделять внешний вид и структуру.

Например, вот это по своей природе - «структура»:

• главы, разделы, подзаголовки;
• шаг 1, шаг 2, шаг 3;
• рисунок 2-1, таблица 3-2;
• «см. главу 4»;
• отсутствие номера страницы только на титульной странице;
• история правок при пересмотре документа.

Однако в «хрупких» документах всю эту структуру пытаются заменить «подгонкой внешнего вида»:

• увеличивать текст, чтобы он был похож на заголовок;
• вручную набирать 1.;
• выравнивать пробелами;
• переходить на новую страницу через Enter;
• набирать текстом «см. страницу 3».

При таком подходе исправление в одном месте ломает что-то в другом.

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

3. Сводная таблица неудачных паттернов и лучших практик

4. Ключевые моменты на практике

4.1 Заголовки только жирным шрифтом и размером текста

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

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

Лучшая практика Назначьте главам, разделам и подзаголовкам стили Заголовок 1 / Заголовок 2 / Заголовок 3. Когда нужно изменить внешний вид, редактируйте сам стиль, а не жирность или размер шрифта в каждой отдельной строке.

4.2 Выравнивание пробелами и многократными Tab

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

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

Лучшая практика Положение и отступы должны определяться не символами, а параметрами абзаца. Используйте отступы, позиции табуляции, интервалы до и после абзаца, а при необходимости - таблицы.

4.3 Переход на новую страницу многократным Enter

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

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

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

4.4 Не набирать оглавление, нумерацию и перекрёстные ссылки вручную

Неудачный паттерн Вручную создавать страницу оглавления и каждый раз перепечатывать названия глав и номера страниц. Набирать 1. 2. 3. или 1.1 1.2 прямо в тексте. Писать текстом «см. страницу 12», «см. рисунок 3».

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

Лучшая практика Стройте автоматическое оглавление на основе стилей заголовков. Шаги оформляйте нумерованным списком, а структуру глав и разделов - многоуровневым списком. Ссылки на номера рисунков, страниц и глав держите как перекрёстные ссылки и поля, обновляя их все разом в конце.

4.5 Не вводить колонтитулы и номер версии вручную на каждой странице

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

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

Лучшая практика Название документа, номер версии и номер страницы вынесите в колонтитулы. Для отдельной титульной страницы используйте параметр «Особый колонтитул для первой страницы», а для переключения по главам или приложениям - разрывы разделов и отключение параметра «Как в предыдущем разделе» для колонтитулов.

4.6 Разделять записи исправлений, комментарии и иллюстрации

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

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

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

5. Минимальный шаблон Word для руководств

Сразу делать сложный шаблон не нужно. Для начала достаточно следующего минимума.

Кроме того, если заранее определить правила эксплуатации хотя бы в таком объёме, дальше будет заметно проще.

• Оригинал хранится в формате .docx
• Распространяется как PDF
• При пересмотре используется запись исправлений
• Перед распространением обновляются поля
• Перед распространением выполняется проверка доступности

6. Проверка перед распространением

Перед тем как превратить руководство в PDF, стоит проверить как минимум следующее.

6.1 Обновление всех полей

Выделите весь текст сочетанием Ctrl + A и обновите поля. Это снижает риск пропущенных обновлений в оглавлении, номерах страниц, перекрёстных ссылках и номерах рисунков и таблиц.

6.2 Проверка записей исправлений и комментариев

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

6.3 Проверка уровней заголовков

Убедитесь, что структура глав последовательно использует Заголовок 1 / 2 / 3. Если это не соблюдено, ломаются оглавление и навигация.

6.4 Проверка изображений и таблиц

Проверьте, что у рисунков и таблиц есть номера, изображения не слишком велики и в тексте объяснено, на что именно смотреть.

6.5 Проверка доступности

Запустите проверку доступности и убедитесь, что нет проблем с заголовками, альтернативным текстом, контрастностью, структурой таблиц и другими элементами. Если планируется распространение в PDF, безопаснее сначала привести всё в порядок именно в Word.

7. Итог

Самое важное, чего стоит избегать при создании руководств в Word, - это держать даже структуру вручную.

• Заголовки - через стили
• Шаги - через функцию нумерации
• Оглавление - автоматическое
• Управление страницами - через разрывы страниц и разделов
• Рисунки и таблицы - через названия (подписи)
• Рецензирование - через запись исправлений и комментарии
• Ссылки - через перекрёстные ссылки
• Обновление и проверка - перед распространением

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

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

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

Похожие статьи

Недавние статьи с теми же тегами помогут подробнее изучить близкие темы.

Связанные темы

Эти страницы показывают тему статьи в более широком контексте услуг и решений.

Услуги по этой теме

Статья напрямую связана со следующими услугами.

Частые вопросы

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

На что в первую очередь стоит обратить внимание при создании руководства в Word?

На разделение внешнего вида и структуры. Структуру глав, нумерацию шагов, оглавление, управление страницами и перекрёстные ссылки нужно поручать функциям Word, а не жирному шрифту и множественным пробелам. Конкретно: заголовки оформляются стилями, шаги - нумерованным списком, оглавление - автоматическим, управление страницами - разрывами страниц и разделов, а ссылки - перекрёстными ссылками. Документ, выровненный вручную, будет ломаться при каждой правке.

Почему нельзя делать заголовки только жирным шрифтом и увеличенным размером текста?

Потому что Word не воспринимает такую строку как настоящий заголовок. Перемещаться по такому документу через область навигации становится сложнее, и он не попадает в автоматическое оглавление. С точки зрения доступности заголовки «только для вида» тоже проигрывают. Главам, разделам и подзаголовкам нужно назначать стили «Заголовок 1 / Заголовок 2 / Заголовок 3», а при необходимости изменить внешний вид - редактировать сам стиль, а не форматирование конкретной строки.

К каким проблемам приводит переход на новую страницу многократным нажатием Enter?

В момент, когда на предыдущей странице добавляется хотя бы одна строка, всё сдвигается. Появляются пустые страницы, заголовок остаётся на предыдущей странице в одиночестве, а колонтитулы переключаются не там, где нужно. Базовое правило - в начале главы использовать разрыв страницы, а там, где нужно изменить обработку номеров страниц или колонтитулов, использовать разрыв раздела. Если структура «поехала», стоит включить отображение непечатаемых символов и проверить разрывы и знаки абзацев.

Что нужно проверить перед распространением руководства?

Как минимум пять вещей. Выделить весь текст сочетанием Ctrl + A и обновить поля, чтобы не пропустить обновление оглавления, номеров страниц, перекрёстных ссылок и номеров рисунков и таблиц. Проверить, что не остались записи исправлений и комментарии. Убедиться, что уровни заголовков согласованы. Проверить номера и размеры рисунков и таблиц. И, наконец, запустить проверку доступности, чтобы выявить проблемы с заголовками, альтернативным текстом, контрастностью и структурой таблиц.

Об авторе

Страница с профилем автора статьи.

Го Комура

Представитель KomuraSoft LLC

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