Всем привет! Я Елена Шустерман, ведущий технический писатель в РТЛабс. Более 20 лет работаю в сфере ИТ. Есть большой опыт работы программистом и аналитиком, сейчас я технический писатель.
Расскажу, как при подготовке отчётной документации оптимизировать работу с документами, в том числе в MS Word с использованием возможностей MS Excel. А ещё как упростить себе рутину при сборке списков сокращений и определений.
Делю статью на две части. Эта часть — первая. Позже будет вторая часть с описанием других возможностей расширенного фильтра MS Word.
Как приходится собирать списки сокращений
Многим коллегам-техписам знакома ситуация, когда пишешь сразу несколько документов, сроки сжатые, а объёмы значительные — по несколько сотен страниц в каждом документе. Часто нужно вставить новый значимый кусок текста, причём так, чтобы он был интегрирован быстро и качественно. При этом нужно следить за корректностью ссылок, форматированием, нумерацией и вложенностью разделов. И хороший техпис знает, как всё это сделать быстро и качественно, не привлекая магию. Ах да, нам же ещё надо собрать сокращения и определения, причём сразу в нескольких доках, по разным проектам и контрактам с разными предметными областями, а сроки горят! Расскажу, как упростить эту часть работы с документами.
Всем нужен глоссарий, а полный глоссарий нужен всем
Сейчас уже нет необходимости кого-то убеждать и подробно объяснять, что разделы с сокращениями и определениями нужны не только в формальных отчётных документах. Хороший глоссарий нужен в любом документе: будь это инструкция к сервису, описание API или документ по ГОСТу.
Как только начинается работа над любым проектом, глоссарий – это лучшее, что должен сделать технический писатель для своей команды: предложить общую терминологическую базу. Ваша команда оценит, если будет иметь такой инструмент для возможности общаться внутри проекта на одном языке.
Хорошая практика — создавать отдельный раздел в Базе знаний с терминами, определениями и сокращениями:
к нему удобно обращаться, если встречается новый термин или сокращение в документации. При введении нового сокращения в работе над проектом нужно не забыть внести его в список.
термины и сокращения из этого раздела будут применяться при составлении документации.
его можно использовать при онбординге, для быстрого входа в проект давать ссылку на раздел с терминами.
в ГОСТе тоже есть рекомендации о составлении списка сокращений и определений.
Как сделать хороший список сокращений
Формируем список в виде таблицы, состоящей из трёх колонок: «Обозначение», «Определение» и «Комментарий».
По ГОСТу рекомендуется выделять в документе два раздела: «Обозначения и сокращения» и «Термины и определения». Предлагаю так и вести эти списки раздельно, чтобы для целей документа легко было найти нужное. Объединить всегда легче.
В поле «Комментарий» можно делать заметки для себя и всей команды, например о том, что термин не используется в каком-то проекте – это важно, чтобы поддерживать единообразие и не упускать изменений. Также в этом поле удобно отмечать синонимы, которые не должны применяться для используемого термина. Здесь можно записать термины на другом языке, которые на проекте пишем в оговорённом варианте. Например: онлайн и on-line или бэкенд и backend.
Список сокращений храним на отдельной странице в Базе знаний для общего доступа и регулярного пополнения. Права на изменения стоит ограничить: добавление и окончательную трактовку терминов лучше обсуждать внутри команды и принимать согласованным решением.
Следим, чтобы список был выстроен точно по алфавиту: удобный поиск глазами и автоматически, самая простая логика размещения. ГОСТ также рекомендует алфавитный порядок – нет смысла тут спорить.
Откуда пришла горилла, или как облегчить задачу по формированию списка
Почему поиск терминов и сокращений в тексте вообще является какой-то отдельной задачей, в чём проблема?
В конце 90-х годов был проведён забавный эксперимент, получивший название «Невидимая горилла». Участникам эксперимента показывали видео, на котором две команды, одна в белых футболках, вторая — в цветных, передавали друг другу мяч. Задание было простым: подсчитать количество передач мяча между игроками в белых футболках. Испытуемые были настолько заняты подсчётом передач на видеозаписи, что большинство из них не заметили человека в костюме гориллы, который вышел на поле и несколько секунд находился там.
Э��сперимент «Невидимая горилла» наглядно демонстрирует эффект перцептивной слепоты. Мозг человека не в состоянии продолжительное время выполнять несколько задач одновременно: следить за качеством текста, смыслами, склонениями, оформлением текста, списков, таблиц и ещё выполнять задачу по сбору сокращений — что-то обязательно начинает ускользать от внимания. В итоге невозможно обеспечить хорошее качество работы сразу по всем направлениям. Это как отвлекаться на смартфон за рулём автомобиля.
Рассмотрим рабочую ситуацию, когда один технический писатель работает над документами сразу из нескольких проектов или нескольких контрактов с различными предметными областями.
Я использую две стратегии оптимизации работы в MS Office.
Первая стратегия: MS Excel и его простые функции
Для сбора раздела с сокращениями использую MS Excel. Под каждый документ завожу отдельную страницу и туда собираю термины и определения.
При работе с документом, вычитке, форматировании каждый новый термин или аббревиатуру, которые считаю нужным добавить в список, копирую себе в отдельную таблицу в MS Excel. Это несложно, никаких правил учитывать не нужно: увидел слово → двойной щелчок мышки по нему (слово выделено целиком) → CTRL+С → перейти в открытую таблицу MS Excel → CTRL+V → вставить в общий столбец. Не нужно задумываться, было уже вставлено ранее это слово или нет, – не слежу за этим, не трачу время и не отвлекаюсь. Не нужно следить за алфавитным порядком этого списка — на данном этапе не отвлекаюсь от текста.
Когда прочитан весь документ, переходим к списку сокращений, который «одним глазом» собран в MS Excel.
В MS Excel использую две очень простые и полезные функции:
«Удалить Дубликаты» — убирает все повторения из собранного списка, оставляет только уникальные строки.
«Сортировка по алфавиту» — выстраивает весь список по алфавиту: сначала латиница, затем кириллица.
Функция «Удалить дубликаты»
Выделить столбец, в меню на закладке «Данные» в разделе «Работа с данными» нажать на «Удалить дубликаты».
Все строки с повторяющимися словами будут удалены. Например, при вычитке сокращение «БД» могло быть три раза внесено в список. После использования функции «Удаление дубликатов» в списке останется только одно уникальное вхождение.
Таким образом весь процесс выбора уникальных вхождений сокращается до трёх шагов.
Шаг 1. Выделить столбец:
Шаг 2. Нажать на кнопку «Удалить дубликаты»:
Убрать галку для настройки «Мои данные содержат заголовки» и нажать «ОК».
Шаг 3. Получить результат: список без повторений:
После выполнения всех действий MS Excel отчитается о проделанной работе:
Функция «Сортировка по алфавиту»
Выделить столбец с терминами, в меню на закладке «Данные» в разделе «Сортировка и фильтр» нажать на «Сортировка от А до Я»:
Следующие три шага, чтобы выстроить список по алфавиту. Шаг 1. Выделить столбец:
Шаг 2. Нажать на кнопку «Сортировать по алфавиту»:
Шаг 3. Получить результат: список, выстроенный по алфавиту:
Готово!
Получили список из собранных сокращений. В готовом списке нет повторений и все строки выстроены алфавитном порядке. И всё это двумя функциями по три шага каждая.
Но есть одно НО
Если вспомнить эксперимент с гориллой, пропадает уверенность, что при вычитке текста техпис перенес в выборку все термины и сокращения. Для того, чтобы точно собрать все аббревиатуры из текста, используем функцию расширенного поиска.
Вторая стратегия: функция расширенного поиска с подстановочными знаками MS Word
После полного форматирования документа запускаем поиск.
Расширенный поиск с подстановоч��ыми знаками
Вызвать окно поиска. Это можно сделать с помощью комбинации клавиш CTRL+F или кнопки «Найти» на верхней панели.
В открывшемся окне «Найти и заменить» на вкладке «Найти» нажать «Больше>>» и установить галочку «Подстановочные знаки».
В поле «Найти» вписать формулу для поиска <[А-ЯA-Z]{2;}>.
Поиск по такой маске выбирает все слова (буквосочетания), состоящие только из прописных (заглавных) букв, в которых могут встретиться и кириллица, и латиница в количестве от 2 букв и больше.
Для кнопки «Выделение при чтении» выбрать «Выделить все».
Для кнопки «Область поиска» выбрать «Основной документ».
После нажатия «Основной документ» запустится поиск: найдутся все слова прописными буквами для латиницы и кириллицы, которые состоят из 2 и более букв.
Результат выделения — на примере текста правил эксплуатации электронного терминала:
Сокращения подсвечены цветом и ещё выделены серым — как будто вы прошлись по тексту и с удержанием клавиши CTRL выделили все слова прописными буквами.
Одним кликом перейти из окна поиска в окно документа и сочетанием клавиш CTRL+C копировать все выделенные слова.
Всё! В кэш-памяти собраны все аббревиатуры, которые есть в документе.
Далее перейти в MS Excel и сочетанием клавиш CTRL+V вставить все выделенные слова в новый столбец:
Удалить дубликаты:
Выстроить по алфавиту:
В среднем на сбор терминов и сокращений уходит не более 3 минут. Это позволяет значительно сэкономить время работы.
Действия при сборке терминов и сокращений:
В MS Excel собрать при вычитке список терминов. Достаточно выбрать только те, которые прописаны строчными буквами, для аббревиатур будет расширенный поиск.
Аббревиатуры и сокращения в тексте, которые стоят прописными буквами, собрать расширенным поиском и скопировать в MS Excel.
В собранном списке функциями MS Excel убрать повторения и выстроить по алфавиту.
В результате нескольких несложных действий в списке собраны термины и сокращения. Однако для документа нужен полноценный раздел с терминами и определениями, с аббревиатурами и их расшифровками.
Процесс наполнения собранного списка определениями и расшифровками сокращений тоже можно ускорить.
В собранном списке сокращений для проставления расшифровок и определений используем общий список из базы знаний, там уже всё есть, нужно только проставить соответствие.
Применим функцию ВПР() MS Excel. Она не работает по кнопке, но её легко применить, если скопируете формулу.
Важно расставить столбцы в правильном порядке. Можно сразу организовать отдельный лист в MS Excel, чтобы потом всегда его использовать, для любых документов.
Функция ВПР() в MS Excel
На отдельный лист скопируйте список из Базы знаний. Дайте наименования для всех столбцов.
Например:
1 — «Сокращения из БЗ»
2 — «Определения из БЗ»
3 — «Сокращения из документа»
4 — «Формулы для соответствия»
5 — «Результат»
В 4 столбец в первую строку скопируйте формулу:
=ВПР(C1;A:C;2;0) — если на листе MS Excel столбцы обозначены буквами.
=ВПР(RC[-1];C[-3]:C[-1];2;0) — если на листе MS Excel столбцы обозначены цифрами.
Что делает формула: для каждой ячейки столбца С (сокращения из документа) находит точное совпадение в крайнем левом столбце А (сокращения из БЗ) и как результат возвращает соответствующее определение из столбца В той же строки (определения из БЗ).
Параметры, которые указываются в формуле:
1 параметр — номер ячейки (по горизонтали и по вертикали), где лежит сокращение, для которого нужна расшифровка. Для строки 1 это будет ячейка С1, так как именно в столбце С у нас расположены сокращения из документа.
2 параметр — указывается вся таблица, которую рассматривает функция ВПР(), – в формуле перечисляем, что это столбцы от А до С (так в MS Excel перечисляются А, В, С).
3 параметр — указываем номер столбца, из какого нужно брать результат поиска.
4 параметр — цифра 0 — параметр поиска точного совпадения. Для наших целей всегда ставим 0.
Эту формулу нужно «протянуть» для всех строк. Сначала выбрать ячейку с формулой, которую нужно заполнить, затем выделить ячейки под ней и нажмите CTRL+D.
В итоге получится готовый список сокращений, который можно переносить в документ.
Для тех строк, где не было найдено точное соответствие, в результате работы формулы будет указано значение #Н/Д (нет данных).
Возможные варианты, почему не найдено соответствие
Проблема: в списке БЗ реально не нашлось такое сокращение.
Решение: самостоятельно найти определение в других источниках, потом внести в БЗ, чтобы в следующий раз всё нашлось😉.
Проблема: в сокращении, которое скопировано из документа, есть ошибка (например, СЛИНС вместо СНИЛС) либо слово из документа скопировано не в именительном падеже.
Решение: исправить ошибки.
Проблема: лишние пробелы в начале или конце строки (формула =ВПР() ищет точное совпадение).
Решение: достаточно убрать лишние пробелы в этой ячейке в столбце С.
Итог
в таблицу MS Excel собрать термины и сокращения в ходе читки текста, потом в MS Excel удалить двойников и выстроить по алфавиту.
в MS Word расширенным поиском с подстановочными знаками собрать все аббревиатуры прописными буквами.
в MS Excel функцией =ВПР() собрать определения и расшифровки из готового списка с Confluence.
Эти несложные шаги помогают упростить сборку сокращений и определений в документах.