Советы по оформлению документации

Есть несколько простых «правил», следуя которым, можно создавать более аккуратные и достоверные документы, будь-то чертеж или письмо.

Если есть возможность, дайте «дышать» элементам, пусть будет просторно. Не прижимайте одно к другому.

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

Можно сделать большой объем текста визуально более легким, если немного увеличить в настройках параграфа в текстовом редакторе отступ после абзаца.

Обычно, чем значимее элемент, тем больше отступ. Соответственно перед заголовком нужно больше места, чем после него. А после заголовка должно быть не меньше, чем между последующими строками, параграфами или элементами списка. Таким образом вы показываете и поддерживаете иерархию блоков. Документ смотрится более гармонично.

А вот между одинаковыми объектами должны быть равные отступы.

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

Используйте кегль, соразмерный документу. Не надо совмещать на странице огромный и мелкий текст. Не стоит писать здоровенными буквами, если это не плакатный заголовок.

Используйте соразмерный кегль и на подписях чертежа. Они должны быть читаемыми, но не доминирующими.

Безжалостно избавляйтесь в документе от всего, что не несет смысловой нагрузки. Лишние рамочки, подчеркивания, линии, тени, эффекты — всё в корзину.

Используйте тире, а не дефис, когда это требуется по правилам. Всего-то нажать alt с минусом, а не просто минус. Ну а если будете отличать короткое от длинного тире, то это вообще фантастика. А так их девять видов.

72 м²      И. И. Иванов     и т. д.     геодезии и картографии    25 000 руб.    Кадастр – это… 

Используйте правильные кавычки: «ёлочки» и „лапки“ внутри ёлочек. Чтобы легко ставить их и другие знаки, установите и приучитесь пользоваться раскладкой Бирмана.

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

В списках почти всегда лучше использовать выравнивание по левому краю.

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

Используйте максимально простые маркеры списка в перечислениях, а числовые, только когда имеет значение очередность элементов списка. Если используете числа или буквы со скобкой, то текст начинается со строчной буквы и заканчивается точкой с запятой. Если число или буква с точкой, то с прописной (заглавной), а в конце каждого пункта ставится точка.

Всегда используйте стили в текстовых и графических редакторах.

Не надо ставить знаки препинания в конце заголовков.

Не ставьте «г.» после даты в формате «DD.MM.YYYY». Пишите либо «15 марта 2015 года», либо «12.03.2015». А вот если в названиях разных версий одного файла дописывать дату в обратном формате «YYYY.MM.DD», то они будут автоматически правильно сортироваться.

Если вы копируете текст из интернета, например из Консультанта, то можно в MS Word убрать сразу все гиперссылки, нажав CTRL+A и потом CTRL+SHIFT+F9 (FN+CMD+SHIFT+F9 на Mac).