СРК 04.3 Сообщения, предупреждения, вопросы

Для партнеров фирмы «1С», участвующих в бета-тестировании «1С:Предприятия 8.0»
Настоящий документ является рабочим материалом фирмы «1С» и предназначен для ознакомления партнеров фирмы «1С» с техническими
и проектными решениями, используемыми при разработке типовых конфигураций для платформы «1С:Предприятие 8.0».
Данный документ не является окончательной редакцией и в него могут быть внесены изменения.
Публикация, цитирование или иное распространение данного документа или его фрагментов без согласия фирмы «1С» не разрешается.
Система стандартов и регламентов разработки
конфигураций для платформы «1С:Предприятие 8.0»
СТП СРК.04.003.01
Сообщения, предупреждения, вопросы
Дата последней модификации: 30 апреля 2003 г.
Предмет стандартизации
Стандарт содержит описание порядка формирования и использования сообщений, предупреждений, вопросов
(далее кратко .именуются «сообщения», если не требуется указывать категорию информации).
Общие требования
Все сообщения должны быть достаточно информативными и содержательными.
Сообщения составляются в безличной форме: не употребляются местоимения «Вы», «Вас» и пр.
Пример
Неправильно: «У вас недостаточно прав для выполнения обработки».
Правильно: «Недостаточно прав для выполнения обработки».
Имена объектов конфигурации должны даваться так, как они представлены в пользовательском интерфейсе.
Имена объектов конфигурации всегда заключаются в кавычки.
В текстах сообщений не рекомендуется использовать сокращения и аббревиатуры.
Если текст сообщения занимает несколько строк, рекомендуется составлять текст таким образом, чтобы строки
оканчивались на логическую паузу или завершались знаком препинания.
Пример
Текст предупреждения:
«Не рекомендуется изменять значение ставки налога, если
она уже используется в справочниках или документах.»
лучше записать, перенеся «если» на следующую строку:
«Не рекомендуется изменять значение ставки налога,
если она уже используется в справочниках или документах.»
Сообщения
При ссылке в сообщениях на строку табличной части документа обязательно указывается табличная часть и
номер строки это табличной части.
Конфигурация должна выдавать предупреждения с подробными пояснениями перед:
 выполнением:·невозвратных действиях;
 потенциально опасных действиях;
 массовой обработки информационной базы;
 длительных процедур (занимающих долгое время)/
При выдаче сообщений в окно сообщений должно быть понятно, какой объект информационной базы вызвал
сообщение.
Модули проведения не могут выводить диалоговых окон. Вопросы не выдаются внутри транзакций.
При выполнении длительных процедур должны выдаваться сообщения либо в окно сообщений, либо в статусстроку.
Конфигурация должны выдавать сообщения в процессе проведения документов, выполнения расчетов,
обработок и т.д.
Рекомендуется следующий стиль использования маркеров при выводе сообщений процедурой Сообщить():
 СтатусСообщения.Информация - контрольные сообщения об ошибках или незаконченных фрагментах в
алгоритмах конфигурации, например «здесь обработка не доделана...»;
 СтатусСообщения.Внимание - предупреждения о некритических ошибках, на которые следует обратить
внимание, но которые не мешают дальнейшему исполнению процедур;
 СтатусСообщения.Важное - сообщения о критических ошибках, из-за которых исполнение выполняемых
процедур прекращается;
 СтатусСообщения.ОченьВажное - сообщения о фатальных ошибках;
 СтатусСообщения.Обычное - вывод информационных сообщений, например, сообщений о проведенных
документах из обработки проведения, и т. д;
 СтатусСообщения.БезСтатуса - строки, содержание которых продолжает ранее выведенные сообщения,
маркером не отмечаются, чтобы проще было отыскивать начало сообщений.
Вопросы
Ответом по умолчанию должен быть такой, который приносит наименьший вред. Для критических ситуаций
ответом по умолчанию не должен быть «Да».