Требования, предъявляемые к программным продуктам, разработанным для системы программ "1C:Предприятие 8"

Требования, предъявляемые к программным продуктам, разработанным для системы программ "1C:Предприятие 8" и представленным на сертификацию в фирму "1С" для получения логотипа "Совместимо! Система программ 1С:Предприятие"

1. Общие требования

1.1. Программный продукт, представленный на сертификацию, должен быть предназначен для тиражного распространения, и не иметь ориентации на конкретное внедрение. Это означает, что продукт должен продаваться или быть предназначен для продажи любому юридическому или физическому лицу, изъявившему желание его приобрести, и может быть внедрен и использован без помощи специалистов организации-разработчика.

1.2. Продукт должен иметь документацию (руководство пользователя) в печатном виде. Для продуктов, предназначенных для работы в Интернете и распространяющихся через Интернет, допускается  наличие руководства  пользователя только  в электронном виде (без предоставления печатной копии).

1.3. В руководстве пользователя должно быть в явном виде описано взаимодействие продукта с "1С:Предприятием".

1.4. Программный продукт должен использовать штатные и документированные возможности работы с "1С:Предприятием 8".

1.5. Продукт, ориентированный на конечного пользователя, должен иметь средства установки. Средства установки, при их наличии, должны быть описаны в документации к программному продукту.

1.6. Использование логотипа "1С" в оформлении программного продукта и названия "1С" в его наименовании допускается только по специальному согласованию с фирмой "1С", например, для совместных с фирмой "1С" разработок. Использование логотипа 1C:Франчайзинг допускается для продуктов партнеров-франчайзи. В случае успешной сертификации фирма-разработчик имеет право использовать для оформления логотип "1C:Совместимо!".

1.7. При внесении исправлений или изменений в сертифицированный продукт,  связанных с изменениями в законодательстве и исправлением ошибок, разработчик обеспечивает соответствие измененного продукта требованиям, предъявляемым при сертификации. В случае внесения изменений, нарушающих требования сертификации, фирма "1С" имеет право приостановить действие сертификата. Новые редакции ранее сертифицированных продуктов, отличающиеся по функциональности от предыдущих версий, должны быть сертифицированы заново.

2. Требования к конфигурациям, разработанным в среде "1С:Предприятие 8"

2.1. Начальные действия при работе конфигурации.

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

2.1.2. Первоначальное заполнение ИБ должно быть разделено на обязательное, без чего конфигурация не будет работать, и необязательное, которое облегчает начало эксплуатации продукта, но не является строго обязательным.
Первоначальное необязательное заполнение может отсутствовать. На выполнение необязательного заполнения пользователю должен выдаваться запрос.

2.1.3. По результатам обработки информационной базы при первом запуске конфигурации или при первом запуске нового релиза конфигурации пользователю должен быть представлен отчет об изменениях, внесенных в информационную базу. Ситуации, когда обработка не проведена в требуемом объеме, должны контролироваться конфигурацией. При этом пользователю должно выводиться предупреждение о возникновении проблемной ситуации.

2.1.4. Не допускается хранение части логически целостной информационной базы во внешних файлах. Отдельно могут храниться только внешние данные по отношению к задаче, решаемой конфигурацией.

2.2. Оформление объектов конфигурации.

2.2.1. Синоним объекта метаданных обязательно заполняется. Синоним начинается с большой буквы, точки ставятся только после сокращений.

2.2.2. Основные объекты конфигурации: Константы, Справочники, Документы, Журналы документов, Перечисления, Отчеты, Обработки, Планы видов характеристик,  Планы счетов,  Планы видов расчета, Регистры сведений, Регистры накопления, Регистры бухгалтерии, Регистры расчета - сортируются в дереве конфигурации по представлению и по возрастанию.

2.2.3. Все объекты, предполагающие интерфейс с пользователем и не имеющие средств автоматического или интерактивного вызова из других объектов, должны быть выведены в меню.

2.2.4. Конфигурация не должна иметь созданных, но не используемых объектов, элементов меню и кнопок панелей инструментов.

2.2.5. Конфигурация в целом и ее основные объекты, имеющие свойство "Справочная информация", должны иметь пользовательское описание. Для объектов справочная информация должна содержать сведения:

  • о назначении объекта;
  • о способах его вызова - из меню программы, из других объектов;
  • о порядке и особенностях ввода информации;
  • описание реквизитов объекта, используемых пользователем.

Содержимое справочной информации основных объектов конфигурации должно включаться в общее описание конфигурации.

2.3. Оформление диалоговых форм.

2.3.1. В документации к конфигурации должно быть указано, для какого разрешения экрана и размера шрифта предназначена конфигурация.

2.3.2. Элементы диалогов форм должны быть выровнены. Это значит, что левые, правые, верхние или нижние границы любых двух расположенных рядом элементов (за исключением элементов типа "Надпись") должны располагаться на одной вертикальной или горизонтальной линии.

2.3.3. Для элементов диалога, информация в которые вводится пользователем, должны быть предусмотрены  подсказки.

2.3.4. В случае использования фрагментов конфигураций, разработанных фирмой "1C" , оригинальная часть конфигурации не должна отличаться по стилю оформления и написания от включенных частей типовых конфигураций.

2.3.5. При наличии в форме картинок допускаются как кнопки с картинками без надписи, так и с картинкой и с надписью. Картинки для обозначения стандартных действий должны быть такими же, как и на панелях инструментов. Изображение картинки должно соответствовать выполняемым по кнопке действиям.

2.3.6. Формы объектов конфигурации, вызываемые как сервисные из других форм, не должны открываться интерактивно (через элемент меню "Операции").

2.4. Общие принципы оформления модулей.

2.4.1. Текст модулей должен быть выровнен синтаксическим отступом.

2.4.2. Конфигурация не должна содержать синтаксических ошибок в текстах модулей.

2.4.3. Все переменные модуля управляемого приложения, модуля обычного приложения, модуля внешнего соединения, а также все экспортируемые переменные должны иметь комментарии. Комментарии должны быть достаточно подробными, чтобы пояснять назначение переменных.

2.4.4. Процедуры и функции модуля приложения, общих модулей и экспортируемые должны предваряться заголовком. Заголовок имеет цель пояснить назначение и использование функции (процедуры) и размещается перед ее объявлением. В заголовке должно быть отражено:

  • назначение и порядок использования процедуры (функции);
  • параметры ее вызова;
  • возвращаемые значения - для функций.

2.4.5. Ключевые слова КонецПроцедуры и КонецФункции должны сопровождаться комментарием с указанием имени процедуры или функции.

2.4.6. Тексты модулей в сложных алгоритмах должны содержать комментарии. Если комментарий относится к модулю в целом, то он располагается в начале модуля (заголовок модуля). Если комментарий относится к оператору или группе операторов, то он должен располагаться перед комментируемым оператором (группой операторов).

2.4.7. Комментарии должны быть достаточно понятными, чтобы пояснять работу модуля или комментируемого оператора. Тексты комментариев должны составляться в деловом стиле, быть эмоционально сдержанными и не содержать слов, не относящихся к функциональности программы.

2.5. Сообщения, предупреждения, уведомления.

2.5.1. Все сообщения (предупреждения, уведомления) должны быть достаточно информативными и содержательными. Имена объектов конфигурации в сообщениях (предупреждениях, уведомлениях) должны даваться так, как они представлены в пользовательском интерфейсе.

2.5.2. Конфигурация должна выдавать предупреждения с подробными пояснениями перед выполнением потенциально опасных действий. Потенциально опасными действиями считаются такие действия, исправить последствия которых можно либо путем повторного ввода информации, либо восстановлением данных из резервной копии.

2.5.3. Конфигурация должна выдавать предупреждения с подробными пояснениями перед выполнением процедур, занимающих продолжительное время.

2.5.4. При выдаче в окно сообщений информации, связанной с конкретным объектом информационной базы, должно быть явно указано, какой объект информационной базы вызвал появление сообщения.

2.5.5. Модальные диалоги, вопросы, предупреждения не должны вызываться внутри транзакций записи и проведения.

2.5.6. При выдаче пользователю вопросов с несколькими вариантами выбора ответа, по умолчанию должен предлагаться ответ, выбор которого вызывает действия, либо наиболее безопасные для информационной базы, либо предусматривающие контроль пользователя за выполнением действий.

Пример 1. Если пользователю предлагается выбор между "Удалить" и "Пометить на удаление", выбором по умолчанию должен быть "Пометить на удаление".

Пример 2. Если пользователю предлагается выбор между ответами "Печатать без предварительного показа" и "Печатать с предварительным показом", выбором по умолчанию должен быть "Печатать с предварительным показом".

2.6. Документация по конфигурации.

2.6.1. Конфигурация должна поставляться с документацией. Документация должна включать разделы, описанные ниже.

  • Оглавление.
  • Инструкция по установке. Описание начальной установки конфигурации. Описание должно быть таким, чтобы  продукт мог установить конечный пользователь.

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

  • Концепция конфигурации. Описание общих моментов, подходов к ведению учета, используемых моделей и принятых допущений. В описании конфигурации должны быть перечислены основные объекты и механизмы, заимствованные из типовых конфигураций разработки фирмы "1C", со ссылками на соответствующую типовую конфигурацию.
  • Описание учетных схем. Сборник типовых задач, стоящих перед пользователем, с описанием их решения средствами конфигурации.

    Примеры данных и снимки экранов, приводимые в описании, должны соответствовать демонстрационной базе из комплекта поставки конфигурации. Все решения, описанные в этой части документации, должны быть проиллюстрированы в демонстрационной базе.

  • Руководство пользователя. Описание интерфейса и ключевых моментов поведения объектов конфигурации.

2.6.2. При использовании в конфигурации внешних компонентов собственной разработки, их свойства и методы должны быть описаны в документации. Если эти свойства и методы являются принципиально защищаемыми участками кода программы, то их достаточно перечислить.

2.6.3. Выпуск новых релизов конфигурации должен сопровождаться описанием изменений в релизе. Пользовательское описание изменений готовится в виде файла в формате txt или html, в котором перечислено, что изменилось в этом  релизе. Пользовательское описание должно быть ориентировано на конечных пользователей конфигурации.

2.7. Поставка конфигурации.

2.7.1. Для упрощения процесса создания и обновления информационных баз пользователем конфигурация должна инсталлироваться на компьютере пользователя в соответствии с рекомендациями фирмы "1С" определенным образом - все шаблоны должны находиться в подкаталогах предопределенного каталога и сопровождаться файлами-манифестами, описывающими установленные шаблоны. Имена параметров инсталляции должны быть уникальными.

2.7.2. Конфигурация должна поставляться с установленной поддержкой.

2.7.3. Конфигурация должна поставляться с демонстрационным примером в отдельной Информационной Базе, содержащей данные гипотетического предприятия в виде законченного примера. В примере не допускаются имена объектов данных типа "Тест", "Товар 1", "Контрагент 3" и подобные. Также нежелательны "условные" заполнения полей документов и справочников, например: "Назначение 1", "Содержание 1".

2.7.4. Наполнение демонстрационной базы должно быть таким, чтобы сформированные отчеты содержали информацию, отражающую назначение отчета. Недопустимо формирование отчетов, содержащих только заголовки.

2.7.5. Модули конфигурации не должны быть защищены паролями. На сертификацию принимается продукт, в поставку которого включены исходные тексты модулей объектов. Однако допускается, что поставка для пользователей может быть сформирована без включения некоторых исходных текстов модулей.

2.7.6. Конфигурация может быть защищена аппаратным или программным способом. В этом случае:

  • описание установки аппаратной защиты должно быть включено в печатное руководство;
  • в руководстве пользователя должно быть отражено, что данный продукт не является полностью конфигурируемым;
  • так как защищенная конфигурация не является полностью доступной для изменения, то разработчики берут на себя ответственность за ее корректную работу и полное соответствие требованиям сертификации в части недоступных для пользователя участков конфигурации;
  • фирма "1С" может указывать в рекламной информации по данному продукту,  что он содержит фрагменты, которые не могут быть изменены в процессе его настройки на особенности учета на конкретном предприятии.

3. Требования к дополнениям Типовых конфигураций,  разработанным в среде "1С:Предприятие 8"

3.1. Программные продукты, представленные в данной категории, позволяют расширить возможности  существующих Типовых конфигураций. Они могут включать в себя пример Типовой конфигурации с добавленными объектами или только добавленные объекты, которые необходимо присоединить к текущей конфигурации.

3.2. Дополнения к Типовым конфигурациям должны удовлетворять всем требованиям, предъявляемым к конфигурациям, в части дополненных объектов, но документация к ним должна содержать не полное описание всей конфигурации, а только ту часть объектов, которые были добавлены к ней.

3.3. В документации должно быть указано, для какой Типовой конфигурации этот продукт можно применять.

3.4. Документация должна содержать методику подключения дополнения в Типовую конфигурацию и внесения изменений при смене релиза Типовой конфигурации. В случае затруднения полного описания такой методики, в документации должно быть указано, что разработчик предоставляет пользователю свой продукт с уже внесенными изменениями после выхода релизов Типовых конфигураций.

3.5. Все добавленные объекты и реквизиты конфигурации должны иметь в названии префикс, выделяющий их от объектов Типовой конфигурации, в дереве конфигурации они должны располагаться после соответствующих объектов типовой конфигурации.
3.6. В текстах модулей все добавленные фрагменты к Типовой конфигурации должны быть выделены комментариями.

4. Требования к комплекту сервисных отчетов и обработок, разработанных в среде "1С:Предприятие 8"

4.1. Комплект сервисных отчетов и обработок предоставляет дополнительный сервис при использовании конфигураций. Программные продукты, представленные в данной категории, должны удовлетворять всем требованиям, предъявляемым к Конфигурациям в части оформления продукта и использования средств "1С:Предприятия 8".

5. Требования к внешним компонентам системы программ "1С:Предприятие 8"

5.1. Внешние компоненты системы программ "1С:Предприятие 8" должны быть разработаны в соответствии с технологией создания внешних компонентов 1С:Предприятия, поставляемой фирмой 1С.

5.2. Все свойства и методы внешнего компонента должны быть описаны в документации.

5.3. В руководстве пользователя должна быть описана технология подключения внешних компонентов к системе 1С:Предприятие 8 с приведением иллюстрирующих примеров на конфигурации 1C:Предприятия 8.

5.4. Все объекты конфигурации, в которых есть примеры использования внешнего компонента, должны иметь описание, поясняющее работу компонента, включенное в справочную информацию.

5.5. В текстах модулей все места подключения и использования методов внешнего компонента должны быть выделены комментариями.

6. Требования к продуктам системы электронных расчетов типа "Клиент  банка", соответствующим стандарту обмена данными "1С:Предприятие" - "Клиент банка"

6.1. Программный продукт типа "Клиент банка", должен соответствовать стандарту обмена данными, публикуемому на диске Информационно-технологического сопровождения (ИТС).

6.2. Для программы этого класса допускается отсутствие "коробочного" вида продукта.

6.3. Программа должна иметь дистрибутив, документацию (допускается электронная версия), гарантийные обязательства по сопровождению (или бланк договора). В документации должно быть указано, как пользователь должен настроить программу для обмена данными с "1С:Предприятием", и как производить обмен данными.

6.4. Для прохождения процедуры сертификации необходимо предоставить демонстрационную базу для показа взаимодействия "Клиент банка" - "1С:Предприятие".

7. Требования к продуктам, использующим различные способы взаимодействия и обмена данными с системой 1С:Предприятие 8

7.1. В руководстве пользователя должно быть указано для какой версии "1С:Предприятия" интегрирован продукт.

7.2. Программные продукты, интегрированные с системой "1С:Предприятие", должны со стороны "1С:Предприятия 8" использовать только штатные и документированные средства для взаимодействия и обмена данными.

7.3. В руководстве пользователя должна быть описана технология и механизм взаимодействия между программами с приведением иллюстрирующих примеров.

1C:Enterprise Developer's Community