Всем привет! Меня зовут Екатерина Мишинёва, я ведущий технический писатель с опытом работы в IT-компаниях более 10 лет.
На заре моей карьеры у меня очень часто при написании документов вставал вопрос как максимально быстро и эффективно сделать так, чтобы документ соответствовал стандартам и был полностью пригоден для сдачи.
Постепенно у меня сложился свой чек-лист, которым бы хотела поделиться. Быть может, перечень не исчерпывающий и кто-то предложит свои дополнения, тем самым сообща прокачав его.
Итак, я выделю два направления — общая проверка и прикладные действия. По умолчанию, все действия выполняются в MS Word.
Общая проверка
-
Проверить на соответствие стиля и структуры документа установленным требованиям:
Документ должен быть структурирован по разделам, подразделам и пунктам;
Стиль документа должен соответствовать корпоративным стандартам.
-
Убедиться в правильности использования технической терминологии:
Все термины, определения и сокращения должны быть точными и соответствовать контексту;
Все термины и сокращения должны встречаться и употребляться в тексте, иначе удалить из перечня;
Не должно быть двусмысленности в терминологии.
-
Проверить точность и полноту информации:
Вся информация, представленная в документе, должна быть точной и полной;
Убедиться, что все необходимые детали присутствуют.
-
Оценить ясность и понятность изложения:
Текст должен быть написан простым и понятным языком, без сложных оборотов и длинных предложений, если иное не требуется при подготовке документа;
Упростить сложные идеи и понятия, используя аналогии и примеры.
Прикладные действия
-
Проверить наличие и правильность оформления перекрестных ссылок:
Убедиться в наличии всех необходимых ссылок на другие разделы и документы;
Проверить правильность оформления ссылок (номера страниц, названия разделов);
Проверить на наличие битых ссылок (в поиске по документу набрать "Ошибка").
-
Проверить грамматику и орфографию:
Грамматика и орфография документа должны быть безупречными;
Встроенным инструментом "Орфография и грамматика" (вкладка "Рецензирование") пройти по всему документу и исправить, где это необходимо, все ошибки;
Проверить документ на наличие ошибок и опечаток (можно несколько раз пробежаться глазами по документу).
-
Проверить форматирование документа:
Шрифт, размер шрифта, межстрочный интервал, отступы и колонтитулы должны соответствовать требованиям;
Изображения и таблицы должны быть оформлены в соответствии с корпоративными стандартами;
Нумерация страниц должна быть в корректной последовательности — титульный лист без номера, нумерация должна начинаться со 2 страницы. Общее количество страниц должно быть равно номеру на последней странице.
-
Проверить малозаметные моменты, которые обычно портят все впечатление о документе:
Через комбинацию Ctrl+H открыть окно "Найти и заменить";
В поле "Найти" ввести двойной пробел " ", в поле "Заменить" ввести одинарный пробел " " и нажать "Заменить все" — чтобы по документу не было ненужных двойных пробелов, порой, это бывает очень критично;
В поле Найти" ввести верхние кавычки ", в поле "Заменить" ввести команду ALT+0171 — кавычка елочка открывающая "«" или ALT+0187 — кавычка елочка закрывающая "»" и нажать "Заменить все".
-
Проверить оформление списка литературы и источников:
Список литературы должен быть оформлен в соответствии с установленными требованиями.
Все источники, на которые есть ссылки в тексте, должны быть указаны в списке литературы.
Вот мой перечень полезных действий, которые помогут привести документ к качественному виду. Делитесь в комментариях своими фишками и дополнениями к посту, так для всех будет большая польза!
Комментарии (19)
Surrogate
15.10.2023 12:35+1В поле Найти" ввести
У меня еще бзик: заменяю пробел на неразрывный пробел в названиях организаций и делаю замену пробелов и дефисов на неразрывные пробелы и дефисы в названиях нормативных документов.
Вот мой перечень полезных действий
К счастью в моей организации бо́льшая часть из вашего списка автоматизирована с помощью макросов Word в корпоративном шаблоне)
document_moscow_me Автор
15.10.2023 12:35+1Ооо, да, это знакомая история по поводу неразрывных пробелов :) в одной из компаний у меня это было очень важным условием, из-за которого могли сразу завернуть документ ????
А макросы это да - очень сильно все упрощают! Главное всегда - найти время на внедрение это корпоративный шаблон, порой, это не самый приоритет)
Surrogate
15.10.2023 12:35+1В нашем случае корпоративный шаблон появился в 2007, тогда в соответствии с ним оформляли преимущественно Технические задания!
В 2016 количество документации которую необходимо «причесать» стало расти стремительным домкратом, пришлось добавлять в шаблон средства автоматизации!
document_moscow_me Автор
15.10.2023 12:35+1Спустя столько времени многие компании, естественно, не все, как это ни странно, только начинают задумываться об автоматизации. В моей практике в одной из компаний используют markdown-разметку, кто то использует дорогостоящий софт, такой как clickhelp например, достаточно удобный и функциональный. Наверно следующий пост придется сделать про автоматизацию, чтобы было всем полезно, давно хотела)
Surrogate
15.10.2023 12:35Наверно следующий пост придется сделать про автоматизацию, чтобы было всем полезно, давно хотела)
Будем ждать с нетерпением )
Germanjon
15.10.2023 12:35+2Убедиться в правильности использования технической терминологии:
Должен быть указан регламентирующий документ для терминов, которые используются в тексте документа и не приведены в глоссарии. Например строкой "Все термины, не указанные в этом глоссарии, используются в соответствии с ГОСТ ХХХ. Бывает полезно, когда создаются документы, уходящие за периметр организации
document_moscow_me Автор
15.10.2023 12:35Достаточно полезный комментарий, я этого не знала, не приходилось сталкиваться даже с такими требованиями.
Поделитесь опытом, пожалуйста, что это за документы, где могли встречаться такие требования?
Germanjon
15.10.2023 12:35+1У меня есть пример из другой страны. В Узбекистане есть локальные стандарты, которые описывают понятийный аппарат для той или иной области. Парочку ссылок: термины в ИТ, термины по криптографии. Иногда встречались кейсы, когда возникали разночтения по тексту документа и тогда приходилось обращаться именно к этим стандартам, как к высшему арбитру.
Возможно, в Российской Федерации есть аналогичный утверждённый глоссарий федерального масштаба в виде стандарта или официальной публикации.
BeLord
15.10.2023 12:35+1Когда-то люди писали документацию, прошло 50 лет на нее смотришь и понимаешь, что это документация. Так вот, была такая должность корректор, а еще был
норма контролери был технический писатель и как показывает практика, разделение обязанностей позволяло получить качественный продукт. Сейчас пытаются повесить весь функционал на технического писателя, результат, за редким исключением, так себе.Surrogate
15.10.2023 12:35+1Один мой друг работу с текстом документа разделял на 4 основные задачи:
Редактирование текста (вычитка). Редактирование — это обработка редактором текста на предмет русского языка (делает его более понятным, легко читаемым), устраняет стилистические и грамматические ошибки.
Корректура текста. Корректура выполняется специалистом в определенной области. К примеру, этот человек точно знает что такое «snapshot» и какой у него аналог в русском языке. И исправляет неточности и технизмы.
Форматирование. Форматирование — это приведение стилей текста к единообразию, наличие подписей к рисункам, таблицам. Текст по смыслу он не правит.
Вёрстка. Вёрстка — это процесс взаимного расположения текста в документе. К примеру, чтобы надпись у рисунка не уезжала от самого рисунка на следующую страницу (т. н. абзацы-вдовы). Или заголовки не оставались на предыдущих страницах (т. н. абзацы-сироты).
По уровню профессионализма эти процессы по нисходящей.
Обычно под форматированием я понимаю все четыре процесса, если есть на это время.
document_moscow_me Автор
15.10.2023 12:35+1Соглашусь! Трансформация данной профессии прям конкретная, и современный технический писатель обвешан очень обширными обязанностями. Ну и все-таки надо заметить, что в техническом писательстве есть более узкие направления и разделения - техписатель, который уходит чуть ли не в разработку, хотя на моей практике разработчики порой уходили в техписатели , со знаем языков программирования. А не наоборот.
Также еще одно направления - документация для гос сектора, со своими спецификами.
Ну техписатель - создатель контента, документации более не формального характера.
igorts
15.10.2023 12:35+3О, знакомая деятельность!
еще проверить, на «не отрывать от следующего» для параграфов оканчивающиеся на : (чтобы хотяб один пункт списка шел после двоеточия на одной странице) , аналогично чтобы картинки от подписей не отрывались , названия от таблиц и заголовки не светились в одиночестве на разных страницах с текстом,
еще рамки и надписи по госту - там много хитростей
и да, много что в макросах, оформил в виде кастомного тулбара, который устанавливается всем пользователям, многие так привыкли, что сами просят поставить расширение при переходе на новую машину.
Самые популярные функции - скопировать в документ наборы предопределенных стилей для разных типов документов (договоры, проектная документация и тд), установить отступы на страницах согласно стандарту, назначить горячие клавиши на популярные стили и тд
document_moscow_me Автор
15.10.2023 12:35Ну это вообще полезная вещь, это хорошо в рамках ворда, все упрощает. Ну а макросы это палочка - выручалочка для тех писа без условно ????????
krakenkaken
15.10.2023 12:35+1Весь последний месяц фантазирую об автоматизации таких проверок. Например:
Устанавливаешь в браузер экстеншен с проверками (если работаешь в облачном ворде, конечно).
Добавляешь стандартные проверки типа орфографии, пунктуации, типографики, битых ссылок, тавтологий.
Создаешь свои проверки: корпоративный стиль, стоп-слова и так далее.
Кликаешь "Проверить" и смотришь все ошибки.
Ручную проверку такая штука бы не отменила, но время сэкономила.
Boomburum
Это может сыграть злую шутку, если вдруг в документе есть куски кода с отбивкой пробелами ) Поэтому я прежде чем сделать «Заменить всё» просматриваю весь документ через CMD+F → CMD+G.
document_moscow_me Автор
Да, абсолютно с вами согласна, это работает при условии, что в тексте нет вставок кода ????????