Чек-лист технического писателя при проверке документации

Всем привет! Меня зовут Екатерина Мишинёва, я ведущий технический писатель с опытом работы в IT-компаниях более 10 лет.

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

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

Итак, я выделю два направления — общая проверка и прикладные действия. По умолчанию, все действия выполняются в MS Word.

Общая проверка

1. Проверить на соответствие стиля и структуры документа установленным требованиям:

   • Документ должен быть структурирован по разделам, подразделам и пунктам;

   • Стиль документа должен соответствовать корпоративным стандартам.

2. Убедиться в правильности использования технической терминологии:

   • Все термины, определения и сокращения должны быть точными и соответствовать контексту;

   • Все термины и сокращения должны встречаться и употребляться в тексте, иначе удалить из перечня;

   • Не должно быть двусмысленности в терминологии.

3. Проверить точность и полноту информации:

   • Вся информация, представленная в документе, должна быть точной и полной;

   • Убедиться, что все необходимые детали присутствуют.

4. Оценить ясность и понятность изложения:

   • Текст должен быть написан простым и понятным языком, без сложных оборотов и длинных предложений, если иное не требуется при подготовке документа;

   • Упростить сложные идеи и понятия, используя аналогии и примеры.

Прикладные действия

1. Проверить наличие и правильность оформления перекрестных ссылок:

   • Убедиться в наличии всех необходимых ссылок на другие разделы и документы;

   • Проверить правильность оформления ссылок (номера страниц, названия разделов);

   • Проверить на наличие битых ссылок (в поиске по документу набрать «Ошибка»).

2. Проверить грамматику и орфографию:

   • Грамматика и орфография документа должны быть безупречными;

   • Встроенным инструментом «Орфография и грамматика» (вкладка «Рецензирование») пройти по всему документу и исправить, где это необходимо, все ошибки;

   • Проверить документ на наличие ошибок и опечаток (можно несколько раз пробежаться глазами по документу).

3. Проверить форматирование документа:

   • Шрифт, размер шрифта, межстрочный интервал, отступы и колонтитулы должны соответствовать требованиям;

   • Изображения и таблицы должны быть оформлены в соответствии с корпоративными стандартами;

   • Нумерация страниц должна быть в корректной последовательности — титульный лист без номера, нумерация должна начинаться со 2 страницы. Общее количество страниц должно быть равно номеру на последней странице.

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

   • Через комбинацию Ctrl+H открыть окно «Найти и заменить»;

   • В поле «Найти» ввести двойной пробел » «, в поле «Заменить» ввести одинарный пробел » » и нажать «Заменить все» — чтобы по документу не было ненужных двойных пробелов, порой, это бывает очень критично;

   • В поле Найти» ввести верхние кавычки «, в поле «Заменить» ввести команду ALT+0171 — кавычка елочка открывающая ««» или ALT+0187 — кавычка елочка закрывающая «»» и нажать «Заменить все».

5. Проверить оформление списка литературы и источников:

   • Список литературы должен быть оформлен в соответствии с установленными требованиями.

   • Все источники, на которые есть ссылки в тексте, должны быть указаны в списке литературы.

   Вот мой перечень полезных действий, которые помогут привести документ к качественному виду. Делитесь в комментариях своими фишками и дополнениями к посту, так для всех будет большая польза!