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

Материал из КинтВики
Перейти к: навигация, поиск
Строка 1: Строка 1:
 
<noinclude>[[Категория:Кинт:Управление санаторием|*]][[Категория:Настройка (КУС)|*]]</noinclude>
 
<noinclude>[[Категория:Кинт:Управление санаторием|*]][[Категория:Настройка (КУС)|*]]</noinclude>
=== Прописные буквы ===
+
{| align="right"
 +
| __TOC__
 +
|}
 +
==== Прописные буквы ====
 
Прописными буквами пишутся названия основных разделов системы: ГЛАВНОЕ, ДЛЯ РУКОВОДИТЕЛЯ, БРОНИРОВАНИЕ, ВЗАИМОРАСЧЕТЫ, ГОСТИНИЦА, УСЛУГИ / РАБОТЫ, МЕДИЦИНА, ПИТАНИЕ, СКЛАД, ПРЕДПРИЯТИЕ, АДМИНИСТРИРОВАНИЕ.
 
Прописными буквами пишутся названия основных разделов системы: ГЛАВНОЕ, ДЛЯ РУКОВОДИТЕЛЯ, БРОНИРОВАНИЕ, ВЗАИМОРАСЧЕТЫ, ГОСТИНИЦА, УСЛУГИ / РАБОТЫ, МЕДИЦИНА, ПИТАНИЕ, СКЛАД, ПРЕДПРИЯТИЕ, АДМИНИСТРИРОВАНИЕ.
  
=== Жирный шрифт ===
+
==== Жирный шрифт ====
 
Жирным шрифтом выделяются:
 
Жирным шрифтом выделяются:
 
* названия крупных объектов, закладок, справочников, форм, полей, разделов интерфейса на формах, кнопок. Например, закладка '''Услуги''', закладка '''Назначенные сеансы''', '''Показатели''', поле '''Пациент''', справочник '''Физические лица''', кнопка '''Редактировать''' и т.д.
 
* названия крупных объектов, закладок, справочников, форм, полей, разделов интерфейса на формах, кнопок. Например, закладка '''Услуги''', закладка '''Назначенные сеансы''', '''Показатели''', поле '''Пациент''', справочник '''Физические лица''', кнопка '''Редактировать''' и т.д.
 
* названия путей до каких-то разделов. Например, '''Администрирование – Безопасность - Настройки доступа'''.
 
* названия путей до каких-то разделов. Например, '''Администрирование – Безопасность - Настройки доступа'''.
  
=== Курсив ===
+
==== Курсив ====
 
Курсивом выделяются названия вариантов чего-либо.
 
Курсивом выделяются названия вариантов чего-либо.
  
=== Кавычки ===
+
==== Кавычки ====
 
В кавычки заключаются:  
 
В кавычки заключаются:  
 
* названия основных документов. Например, документ «Прием платежей», документ «Возврат платежей», документ «Путевка», документ «Назначение услуг» и т.д.
 
* названия основных документов. Например, документ «Прием платежей», документ «Возврат платежей», документ «Путевка», документ «Назначение услуг» и т.д.
 
* уникальные названия, собственные имена. Например, названия фильтров, групп пользователей, системных параметров, названия уникальных документов (их собственные имена) и т.д.
 
* уникальные названия, собственные имена. Например, названия фильтров, групп пользователей, системных параметров, названия уникальных документов (их собственные имена) и т.д.

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

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

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

Жирный шрифт

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

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

Курсив

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

Кавычки

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

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