Чек-лист для оформления документов

Нет ничего, что покажет сильнее, чем плохо отформатированный документ, что вы не специалист в своем деле.

Пускай все переходят на notion, confluence и подобные системы, но работу с документами для аналитика не отменял еще никто. Особенно тяжко, к сожалению, приходится джунам - миддлы и сеньоры радостно скидывают муторную работу по оформлению или компоновке документов на младшеньких, а у тех не хватает опыта хорошо оформить документ с первого (второго, третьего) раза. Потому что все, как и работа с документами, требует опыта.

Хочу поделиться с вами своим чек-листом по оформлению документов. Если следовать правилам, то первое впечатление от документа будет положительное, а иногда этого бывает достаточно, чтобы формально закрыть этап - когда Заказчик уже готов все принять, и не хватает лишь документов. Или просто, чтобы документ был аккуратным и читабельным.

Первый и главный вопрос при работе с документами - есть ли пример документа (уже сданного / принятого Заказчиком)? Его шаблон? Можно запросить или уточнить формат, чтобы не пришлось переделывать.

Второй вопрос - есть ли внутри компании уже требования к оформлению? Возможно, они есть и вы сможете дополнительно проверить себя.

Остальные мои пункты применимы к любому шаблону или документу:

1. Проверяем, что все стили в документе одинаковые, нет абзацев с разными стилями (если это не нужно специально). Это можно сделать через Стили, кнопка в правом нижнем углу блока Стили, открывается окно со стилями. Выбираем стиль →Выделить все. Лишние "левые" удаляем.
2. Все таблицы должны быть одинакового стиля (шапка, выравнивание, шрифт, абзац), в том числе линии таблицы должны тоже быть одинаковые (цвет/толщина, заливка шапки итд).
3. Все таблицы должны быть одинаково расположены на листе. Ни левый, ни правый край таблицы не должны быть расположены в других местах относительно других таблиц. Идеальная ситуация - если все таблицы содержат одинаковую информацию и имеют одинаковую структуру, то ширина колонок тоже должна быть одинаковая.
4. Не надо ставить дополнительные Enter'ы перед или после таблиц. Сделайте отступ абзаца.
5. Все таблицы должны иметь повторяющуюся шапку на каждом листе.
6. Все подписи должны быть одинаковые (подписи к таблицам, подписи к рисункам).
7. Таблицы и рисунки должны иметь ссылочные пункты нумерации.
8. Все кавычки должны быть одинаковые (всмысле кавычки бывают формата "лапки" или "ёлочки"). Проверяем - делаем Замена -> " на ". Все кривые заменятся.
9. Открываем Вид ->Навигация, все заголовки должны быть по порядку и быть соответствующего стиля (заголовок 3го уровня должен быть 3ей вложенности).
10. Все заголовки каждого уровня должны быть одинакового стиля.
11. Не прыгает выравнивание - везде по левому краю или по ширине (но везде - одинаковое).
12. Нет лишних Enter'ов. Проверяем - делаем Замена -> ^p^p на ^p , где р - это английская маленькая p (как в слове pony). Делаем замену несколько раз.
13. Если выше где-то эти Enter'ы стояли, и они были нужны - скорее всего там должен быть большой отступ (например, проверяем титульный лист).
14. Нет лишних пробелов. Проверяем - делаем Замена -> (два пробела) на (один пробел).
15. В тексте нет ненормативной лексики или капслока. Это часто бывает, когда документ пишется как комментарии к коду, с блоками, которые вы собираетесь заполнить попозже, и пишете что-то вроде "Эту хрень я напишу на след неделе". Вы это умрете потом вычитывать, лучше сразу же не пишите. Или, на крайний случай, делайте рецензию выноской.
16. Если есть какие-то сокращения или аббревиатуры, они должны быть объяснены в блоке "Термины или сокращения" или дана сноска.
17. У запятых есть свое место в предложении. Лишние убираем, нужные добавляем. Об этом мало говорят, но ребят, освежите знания русского языка. Меня прямо передергивает от орфографических и пунктуационных ошибок. Это ваш хлеб - работать с текстом. Если уж совсем тяжело, в Word есть автопроверка, есть сайт Орфопрограммка https://orfogrammka.ru/. Пользуйтесь хоть чем-то.
18. В тексте нет битых ссылок. Сначала выделяем все: ctrl+a, f9. Проверяем: нажимаем Найти -> вбиваем "Ошибка!"
19. Все предложения должны иметь точки. Все предложения начинаются с большой буквы, в том числе в таблицах. Особенно большая проблема с этим стоит тогда, когда вы пишете требования в любых программах, кроме MS Word. Вы "накидываете" материал, а когда его выгружает кто-то другой, он(-а) плачет - нужно везде в конце предложений проставлять забытые вами запятые. Не надо так делать.
20. Все буллиты по всему документу имеют одинаковый стиль, если они выглядят одинаково (буллеты с точками, с -, с нумерацией итд).
21. В буллит-списках в конце ставится либо точка; или запятая или точка с запятой, в последнем буллите тогда ставится точка. Да-да, каждый поинт не заканчивается символом Enter, как бы все не хотели.
22. В буллит-списках если точка или точка с запятой, то предложение начинается с маленькой буквы; в случае точки - с большой.
23. Буллит-список - это форматированный список, а не список, где мы сами поставили знак минус/тире/точка в начале; он может быть оформлен через "маркеры" или "нумерацию" (ворд).
24. Если вы пишете формальное Техническое задание, то формулировки требований должны быть следующего формата: "Система должна позволять ...". Если это уже документ, описывающий поведение системы после ее разработки (например, Пояснительная записка или руководства), то формат будет другой: "Система позволяет..".

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

Удачи с документами!