3.7.6. Руководство оперативного пользователя программного средства:

• титульный лист, оформленный по правилам предприятия с учетом требований заказчика;

• ограничения на применение документа и указания на авторские права на программный продукт;

• введение:

• область применения ПС;

• краткое описание функциональных возможностей;

• требования к уровню подготовки пользователя;

• перечень эксплуатационной документации, с которыми необходимо предварительно ознакомиться пользователю;

• назначение и условия применения комплекса программ:

• теоретические основы данного комплекса программ, функции и решаемые задачи;

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

• условия, при соблюдении (выполнении, наступлении), которых обеспечивается применение программного средства в соответствии с назначением, спецификациями требований и ха­рактеристиками системы;

• технические и административные операции для запуска реше­ния функциональных задач;

• предостережения и предупреждения от ошибок пользователей;

• метод решения каждой задачи, их взаимодействие и ограничения;

• подготовка к работе:

• состав и содержание дистрибутивного носителя комплекса программ и данных;

• описание всех выполняемых функций, задач, процедур;

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

• порядок загрузки данных и программ;

• порядок контроля и проверки работоспособности комплекса программ;

• описание функциональных операций ПС для каждой операции обработки данных должно быть указано:

  • идентификатор и наименование операции;

  • условия, при соблюдении которых возможно выполнение операции;

  • подготовительные действия;

  • основные действия в требуемой последовательности функциональных операций;

  • исходные данные, необходимые для корректного функционирования комплекса программ;

  • информация для контроля корректного функционирования комплекса программ;

  • рекомендации как приостановить исполнение заданных функций и провести рестарт комплекса программ;

  • регистрация окончание исполнения заданной функции комплекса программ;

  • заключительные действия для завершения требуемой задачи;

  • оценка ресурсов, расходуемых на операцию или заданную функцию;

• аварийные ситуации:

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

• действия пользователя по восстановлению программ и/или данных при отказе или обнаружении ошибок;

• действия в случаях обнаружения несанкционированного вмешательства в данные;

• гарантии и обязательства по контракту на комплекс программ, а также условия отказа от них;

• рекомендации по обучению и освоению ПС, включая описание контрольного примера, правила его запуска и выполнения;

• приложения детальные сведения о форматах исходных и результирующих данных, структуре файлов и экранов.

3.7.7. Инструкция по формированию и ведению информации базы данных:

• правила подготовки информации данных:

• порядок отбора информации для включения в базу данных;

• правила подготовки и кодирования информации базы данных;

• формы ее представления и правила заполнения этих форм;

• порядок внесения изменений в информацию базы данных;

• порядок и средства заполнения базы данных:

• состав технических средств;

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

• процедуры изменения и контроля информации базы данных:

• состав и последовательность выполнения процедур по контролю и изменению содержания базы данных;

• порядок и средства восстановления информации базы данных:

• описание средств защиты базы от разрушения и несанкционированного доступа;

• правила, средства и порядок проведения процедур по копированию и восстановлению базы данных.

8. Паспорт на программное средство:

• общие сведения о программном средстве:

• идентификатор и наименование ПС;

• его обозначение, присвоенное разработчиком;

• наименование предприятия-поставщика;

• основные характеристики ПС:

• состав функций, реализуемых ПС;

• описание принципов функционирования ПС;

• общий регламент и режимы функционирования ПС;

• сведения о возможности выбора и изменения режимов его работы;

• сведения о совместимости ПС с другими системами и внешней средой;

• комплектность:

• перечень эксплуатационных документов ПС;

• все непосредственно входящие в состав ПС компоненты;

• отдельные средства в комплексе программ, в том числе носи­тели данных и эксплуатационные документы;

• свидетельство (акт) о приемке:

• содержание и дата подписания акта о приемке ПС в промышленную эксплуатацию;

• фамилии и должности лиц, подписавших акт о приемке;

• гарантийные обязательства изготовителя (поставщика):

• сроки и ограничения гарантии на комплекс программ в целом;

• сроки и ограничения гарантии отдельных составных частей, если они не совпадают с условиями гарантии ПС в целом;

• сведения о текущем состоянии комплекса программ:

• сведения о выявленных дефектах;

• замечания по эксплуатации и аварийным ситуациям, принятые меры;

• сведения о изменениях в программном средстве с указанием основания, даты и содержания изменения;

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

8. Пользовательская документация на коммерческие пакеты и закрытые коробки программных средств по стандарту ISO 9127:

• документация внутри коробки:

• цель и назначение ПС;

• справочная документация;

• идентификация пакета ПС;

• составные части пакета ПС;

• функциональное описание ПС;

• инсталляция (сборка) ПС;

• использование ПС;

• технологическая информация по ПС;

• тестирование при применении;

• информация по контрактам;

• глоссарий;

• индекс;

• замечания для конечного пользователя;

• обучающая документация;

• документация для быстрых справок;

• документация на внешней упаковке пакета:

• цель ПС;

• содержание пакета:

• идентификация пакета;

• цель и область применения;

• окружение;

• вход; выход;

• ограничения на данные в файлах;

• инструкция для пользователя;

• дополнительная информация;

• информация по контрактам;

• адреса сервиса для потребителя;

• предметное обеспечение (спецификация);

• стандарты и законы;

• независимая сертификация;

• код продукта;

• цена.