Основы руководств в Word — типичные ошибки и как их исправить

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

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

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

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

В этой статье разбираем те основы Word, без которых руководство не собрать, в формате «плохой приём / рабочий приём».

Для кого эта статья и какую версию она предполагает

Если названия на ленте в вашей среде другие, ищите по имени функции, а не по имени вкладки. «Стиль заголовка», «нумерация», «оглавление», «разрыв», «исправления» от версии не зависят.

Оглавление

1. Сначала вывод
2. Не превращайте Word в инструмент ручного выравнивания
3. Плохие приёмы и рабочие приёмы — сводка
4. Что важно на практике (в 4.7 — шаги по пяти основным функциям)
5. Минимум шаблона Word для руководств
6. Проверка перед распространением
7. Итог
8. Источники

На схеме сплошная линия обозначает отношение, которое выполняется всегда, а пунктирная — условное отношение (условия указаны в пояснении к каждому отношению на странице сведений). Полный список отношений (всего 21, с доказательствами и степенью уверенности) и определения основных понятий собраны на странице сведений карты знаний (на японском). Данные: JSON-LD / Turtle

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.7. Если о самих функциях слышите впервые, сначала посмотрите 4.7, затем вернитесь к 4.1.

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 Разделить запись исправлений, примечания и иллюстрации

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

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

Рабочий приём Сами правки фиксируйте записью исправлений, обсуждения и указания — примечаниями. К рисункам и таблицам добавляйте названия, при необходимости — альтернативный текст.

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

4.7 Кратчайшие шаги по пяти основным функциям

До сих пор речь шла о том, что делать. Ниже — где нажимать, по пяти функциям. Сначала сводка.

Дальше — коротко по каждому шагу.

1. Назначить стиль заголовка

1. Поставьте курсор в строку названия главы (выделять всю строку не обязательно).
2. На вкладке «Главная» в списке стилей выберите «Заголовок 1».²
3. Раздел — «Заголовок 2», подзаголовок — «Заголовок 3».
4. Если нужно сменить внешний вид, не правьте строку напрямую: щёлкните имя стиля правой кнопкой и через «Изменить» поправьте формат. Одна правка выравнивает все строки с этим стилем.

2. Нумерованный список для шагов

1. Выделите строки шагов целиком.
2. На вкладке «Главная» в группе «Абзац» нажмите «Нумерация».⁴
3. Если номерами нужно вести и иерархию глав и разделов, в той же группе откройте «Многоуровневый список» и выберите формат, связанный со стилями заголовков.

Стоит перестать набирать 1. руками — и перестановка и добавление шагов сразу становятся проще.

3. Вставить автоматическое оглавление

1. Сначала закончите назначение стилей из пункта 1. Оглавление подхватывает только строки со стилем заголовка; если этого нет, получите пустое оглавление.
2. Щёлкните в месте вставки (обычно в начале документа).
3. Откройте «Ссылки» > «Оглавление» и выберите «Автособираемое оглавление».²
4. После правки выделите оглавление и выполните «Обновить оглавление». Как обновить весь документ разом, описано в 6.1.

4. Когда разрыв страницы, а когда разрыв раздела

1. Если нужно просто начать со следующей страницы, вставьте разрыв страницы через Ctrl + Enter.³
2. Если с этого места меняются нумерация страниц, содержимое колонтитулов или ориентация листа, на этом месте выберите «Макет» > «Разрывы» > «Следующая страница».⁵
3. У разрыва раздела есть варианты «Следующая страница», «Текущая страница», «Четная страница», «Нечетная страница». В руководствах почти всегда «Следующая страница».⁵
4. Если непонятно, что именно вставлено, на вкладке «Главная» в группе «Абзац» включите «Отобразить все знаки ¶» — тип разрыва будет виден в тексте (Ctrl + Shift + 8; клавиша 8 на цифровой клавиатуре не срабатывает).³

5. Рецензировать записью исправлений

1. До начала рецензирования на вкладке «Рецензирование» включите «Исправления» (Ctrl + Shift + E).⁶³
2. Дальнейшие правки — удаления, вставки, смена формата — остаются в записи. Красный текст руками набирать не нужно.
3. «Обсудить» и «здесь проверить» в текст не пишите — оформляйте примечанием.
4. Фиксацию делайте в группе «Изменения» на вкладке «Рецензирование»: по одному принимайте или отклоняйте.⁶
5. Перед распространением обязательно проверьте, что записей и примечаний не осталось (см. 6.2).

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

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

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

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

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

Перед тем как вывести руководство в PDF, минимум это стоит посмотреть.

6.1 Обновить все поля

Выделите весь текст через Ctrl + A и обновите поля клавишей F9.³ Так меньше шансов пропустить оглавление, номера страниц, перекрёстные ссылки и номера рисунков и таблиц.

6.2 Разобрать исправления и примечания

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

6.3 Проверить уровни заголовков

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

6.4 Проверить изображения и таблицы

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

6.5 Проверка читаемости

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

7. Итог

Главное, чего стоит избегать в руководстве Word, — держать даже структуру вручную.

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

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

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

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

8. Источники

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

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

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

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

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

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

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

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

На что в первую очередь смотреть, когда в Word делают руководство?

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

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

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

Что ломается, если новую страницу набирать многократным Enter?

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

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

Минимум пять пунктов. Выделить весь текст через Ctrl + A и обновить поля клавишей F9, чтобы не пропустить оглавление, номера страниц, перекрёстные ссылки и номера рисунков и таблиц. Проверить, что не остались исправления и примечания. Посмотреть, что уровни заголовков согласованы. Проверить номера и размеры рисунков и таблиц. Запустить проверку читаемости и пройтись по заголовкам, альтернативному тексту, контрасту и структуре таблиц.

Об авторе

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

Го Комура

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

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