- Титульная часть: что это и из чего состоит
- Лист утверждения и согласование
- Титульный лист: что и где писать
- Что ещё может быть на титульном листе
- Пара слов про учёт документов
- Мелкие нюансы, которые раздражают
- Где искать правила оформления?
- Термины, определения, сокращения: как мы их оформляем
- Где размещать?
- Нумеровать или нет?
- Как назвать раздел?
- В каком виде подавать: список или таблица?
- Порядок расположения
- Что включать в раздел?
- Коротко о главном
Расскажу по‑простому, как мы в компании оформляем титульные листы и разделы с терминами и сокращениями. Делюсь лайфхаками — что придумали сами, от чего отказались и почему.
Титульная часть: что это и из чего состоит
По ГОСТу титульная часть включает два элемента:
титульный лист;
лист утверждения.
Разберу каждый пункт подробнее.
Лист утверждения и согласование
Лист утверждения нужен, если на титульнике нет места для подписей. У нас такой практики почти нет — все подписи ставим прямо на титульном листе или на листах согласования. Эти листы появились по просьбе заказчиков, их форма — тоже их идея.
Важные нюансы про листы согласования:
не нумеруем их;
не включаем в общее число страниц;
в электронном виде можем разместить в начале или в конце документа;
бумажные копии иногда храним отдельно.
Подробнее про лист утверждения можно почитать в ГОСТ Р 2.105‑2019.
Титульный лист: что и где писать
Титульник — обязательный элемент. На нём указываем:
Грифы утверждения (если нужно) — вверху: слева «Заказчик», справа «Разработчик».
Групповые заголовки — название проекта (не всегда, зависит от заказчика) и системы.
Подзаголовок — название модуля системы.
Вид документации (например, «Эксплуатационная документация») — если нужно.
Название документа.
Год разработки — внизу, в колонтитуле.
Как располагать текст:
разделяем заголовки пустой строкой (вместо точек);
если в полном названии несколько предложений, на титульнике точки убираем и заменяем их пустой строкой.
Что ещё может быть на титульном листе
По договорённости с заказчиком добавляем:
полное и сокращённое название нашей организации — вверху, отступ от края 2 см;
грифы согласования — слева «Заказчик», справа «Разработчик»;
город и год утверждения — внизу, в колонтитуле;
планируем добавить шифр документа (уникальный код).
Пара слов про учёт документов
Недавно задумались, как лучше вести учёт документации. Пока решаем, какую систему выбрать. Может, у вас есть опыт? Расскажите в комментариях:
как у вас организован учёт?
используете электронную картотеку или бумажную?
какая система регистрации документов кажется вам удобной?
Мелкие нюансы, которые раздражают
Например, у нас на титульнике есть место для даты в грифах — оно обозначено тремя линиями. То есть дату надо вписывать вручную: число, месяц прописью, год. И только так!
Мы просили заказчика оставить одну линию — чтобы подписант сам выбирал формат даты. Не вышло. Единственное, чего добились, — убрали кавычки вокруг даты. Почему:
по ГОСТ Р 7.0.97‑2016 кавычек в дате нет;
кавычки — это пережиток эпохи печатных машинок, когда ими отмечали место для ручной записи.
Где искать правила оформления?
Основные стандарты:
ГОСТ 19.104‑78;
ГОСТ Р 2.105‑2019.
Термины, определения, сокращения: как мы их оформляем
Казалось бы, простые разделы, но вопросов по оформлению куча. Разберу по порядку.
Где размещать?
Ставим в начале документа — первым разделом. Внутри два подраздела:
«Термины и определения»;
«Обозначения и сокращения».
Или делаем два отдельных раздела. Так удобнее: читатель сначала знакомится с терминами, потом читает текст. Хотя ГОСТ разрешает выносить их в приложения — мы так не делаем.
Нумеровать или нет?
Обычно нумеруем — эти разделы часть основного текста. Но для «Технического задания» делаем исключение: размещаем термины и сокращения в конце, без нумерации. Так требует ГОСТ 19.106‑78.
Как назвать раздел?
Зависит от содержания. Варианты:
«Термины, определения и сокращения» — если нет обозначений;
«Термины, определения, обозначения» — если нет сокращений (на практике такого не было);
«Термины, определения, обозначения и сокращения» — если есть и то, и другое.
В каком виде подавать: список или таблица?
Чаще делаем список в виде таблицы с невидимыми границами, три колонки:
Термин.
Тире (узкая колонка, около 4 мм).
Определение.
Настройки таблицы:
поля — ноль;
ширина — по ширине окна;
шрифт — как в основном тексте, без абзацного отступа.
Если делаем таблицу, соблюдаем все правила из ГОСТ Р 2.105‑2019.
Порядок расположения
ГОСТ предлагает несколько вариантов:
от общего к частному;
по порядку упоминания в тексте;
по алфавиту (если терминов больше 20).
Мы всегда делаем по алфавиту — даже если их меньше. Так привычнее. Если есть англоязычные термины, сначала их (по алфавиту), потом русскоязычные.
Для сокращений и обозначений порядок такой:
Обозначения.
Сокращения на иностранном языке.
Сокращения на русском языке.
Что включать в раздел?
Только те термины и сокращения, что есть в тексте.
Термины: берём узкоспециализированные понятия, которым нужно дать определение. Например, слово «Пользователь» может означать и обычного человека, и специалиста от заказчика — тут лучше пояснить.
Сокращения: включаем все, что вводим в тексте, кроме:
общепринятых (т. д., т. п., др.);
адресообразующих элементов (ул., д., обл.);
единиц измерения (см, м, кг);
аббревиатур форм собственности (АО, ООО);
сокращений госорганов (МВД, МЧС);
официальных сокращений (РФ, СНГ).
Если сокращений меньше трёх, ГОСТ советует пояснять их прямо в тексте. Мы так не делаем — всегда оформляем отдельный раздел. Причина простая: так удобнее ориентироваться в электронной версии документа.
Обозначения: обычно расшифровываем сразу после формулы — в примечании или сноске. Это не противоречит стандартам.
Коротко о главном
Титульный лист — обязательный элемент, на нём размещаем основную информацию.
Листы согласования не нумеруем и не включаем в общий счёт страниц.
Термины и сокращения лучше ставить в начале документа — так удобнее читателю.
Оформляем по ГОСТу, но с поправками под свои нужды и удобство пользователей.
Всегда ищем баланс: соблюдаем стандарты, но не теряем здравый смысл.
