Оформление документации — различия между версиями

Материал из КинтВики
Перейти к: навигация, поиск
(Курсив)
Строка 12: Строка 12:
  
 
==== Курсив ====
 
==== Курсив ====
Курсивом выделяются названия вариантов чего-либо.
+
Курсивом выделяются названия вариантов чего-либо. Например:
 
 
Например:
 
  
 
Виды заявок:
 
Виды заявок:

Версия 16:17, 18 сентября 2018

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

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

Жирный шрифт

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

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

Курсив

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

Виды заявок:

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

Кавычки

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

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