Правила оформления документации

Прописные буквы

Прописными буквами пишутся названия основных разделов системы: ГЛАВНОЕ, ДЛЯ РУКОВОДИТЕЛЯ, БРОНИРОВАНИЕ, ВЗАИМОРАСЧЕТЫ, ГОСТИНИЦА, УСЛУГИ / РАБОТЫ, МЕДИЦИНА, ПИТАНИЕ, СКЛАД, ПРЕДПРИЯТИЕ, АДМИНИСТРИРОВАНИЕ.

Жирный шрифт

Жирным шрифтом выделяются:

• названия крупных объектов, закладок, справочников, форм, полей, разделов интерфейса на формах, кнопок. Например, закладка Услуги, закладка Назначенные сеансы, Показатели, поле Пациент, справочник Физические лица, кнопка Редактировать и т.д.
• названия путей до каких-то разделов. Например, Администрирование – Безопасность – Настройки доступа.

Жирный курсив

Жирным курсивом оформляются названия кнопок.

Курсив

Курсивом выделяются названия вариантов чего-либо. Например:

Виды заявок:

• индивидуальная — на одного человека;
• групповая — на несколько (много) человек.

Предусмотрено три вида этого отчета:

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

Кавычки

В кавычки заключаются:

• названия основных документов. Например, документ «Прием платежей», документ «Возврат платежей», документ «Путевка», документ «Назначение услуг» и т.д.
• уникальные названия, собственные имена. Например, названия фильтров, групп пользователей, системных параметров, названия уникальных документов (их собственные имена) и т.д.