Технический писатель не только пишет документы – он их еще и регулярно проверяет. Тут можно выделить три направления деятельности:
- Самопроверка. Всегда и у всех, хотя бы минимальная.
- Проверка работы коллеги, если в отделе существует практика кросс-ревью.
- Нормоконтроль (и исправление) каких-либо входящих внешних файлов по запросу. Например, поступивших из отдела аналитики или продаж.
Поделюсь своей общей методикой, которая, в принципе, применима к любым документам, а не только к техническим.
Использование чек-листа
Если вы начинающий техпис, всегда пригодится пошаговое руководство по проверке в виде короткой инструкции. У опытного технического писателя такой план, как правило, уже прочно сидит в памяти и используется на автопилоте.
Примерный чек-лист выглядит так:
- Проверьте титульный лист. Все ли обязательные реквизиты в наличии, правильные ли подписанты указаны, актуальны ли год и город? Если есть лист утверждения – аналогично.
- Обновите документ (Ctrl + А, затем F9), чтобы посмотреть, нет ли проблем с содержанием, и не появились ли битые ссылки. Отслеживать можно вместе с выполнением пункта ниже.
- Настройте масштаб так, чтобы файл отображался на экране на два листа (в две страницы). Пролистайте вниз, отслеживая лишние пробелы, пустые листы и мелкие проблемы со стилями. Дополнительно можно задать поиск по элементам, оформленным другим стилем шрифта.
- Настройте масштаб так, чтобы файл отображался на экране в один лист. В этом режиме медленно прочитайте весь текст в поисках опечаток и описок. В конце для подстраховки дополнительно используйте ворд-функцию «Рецензирование».
- Проверьте список терминов на полноту и достаточность.
Учет других требований
Чек-лист из пункта выше хорошо подходит, если к документу не предъявляются какие-то особые требования. Задача из разряда «просто должно быть аккуратно оформлено».
Если есть какие-то нормативные документы, работу еще стоит проверить на соответствие им. Но лучше это делать дважды: до старта и после.
Например, Отчет о научно-исследовательской работе и ГОСТ 7.32. В первую итерацию можно сделать шаблон с предварительной разметкой структуры документа, учитывающей требования стандарта. Во вторую – проверить оформление и повторно состав разделов.
Если это методические указания для регистрации продукта в реестре отечественного программного обеспечения, то на старте тоже можно будет выписать требования к содержимому конкретного документа. А на финише –еще раз пройти по списку и отметить, что все пункты выполнены.
А есть ли у вас лайфхаки по проверке документов?