Документирование

Документирование по ГОСТ Р 7.0.8-2013

Запись информации на носителе по установленным правилам [из п. 44 ГОСТ Р 7.0.8-2013]

Формы и основные надписи документов [из подр. 1.2 ГОСТ 24.301-80]

Формы и основные надписи документов [из подр. 1.2 ГОСТ 24.301-80]

Документы следует выполнять на листах бумаги форматов по ГОСТ 2.301. Приняты следующие формы:

  • титульный лист - по ГОСТ 2.105;
  • заглавный и последующие листы - формы 5 и 5 а ГОСТ 2.106;
  • заглавный и последующие листы ведомости держателей подлинников - формы 1 и 1 а ГОСТ 2.106;
  • заглавный и последующие листы ведомости эксплуатационных документов - формы 1 и 1а ГОСТ 2.601;
  • заглавный и последующие листы ведомости документов технического, рабочего (технорабочего) проектов и описи - формы 4 и 4 а ГОСТ 2.106;
  • лист регистрации изменений - форма 2 ГОСТ 2.503.

[из п. 1.2.1 ГОСТ 24.301-80]

Основную надпись заглавных листов выполняют по форме 2, последующие листы - по форме 2а ГОСТ 2.104. В графе 1 указывают наименование документа (части); в графе 2 - обозначение документа (части); в графе 8 - общее количество листов документа (части). Графы 4-6 не заполняют.

Примечание - При наличии титульного листа графу 1 и строку «Утв.» в графах 11-13 не заполняют [из п. 1.2.2 ГОСТ 24.301-80]

Дополнительные графы к основным надписям заполняют в соответствии с требованиями ГОСТ 2.104, при этом в графе 25 указывают краткое наименование системы и (или) номер темы, заказа [из п. 1.2.3 ГОСТ 24.301-80]

На листах документов, выполненных при помощи выводных устройств ЭВМ, допускается наносить основную надпись и дополнительные графы по ГОСТ 2.104 посредством специального штампа [из п. 1.2.4 ГОСТ 24.301-80]

Общие положения [из разд. 1 ГОСТ 34.601-90]

Общие положения [из разд. 1 ГОСТ 34.601-90]

Процесс создания АС представляет собой совокупность упорядоченных во времени, взаимосвязанных, объединенных в стадии и этапы работ, выполнение которых необходимо и достаточно для создания АС, соответствующей заданным требованиям [из п. 1.1 ГОСТ 34.601-90]

Стадии и этапы создания АС выделяются как части процесса создания по соображениям рационального планирования и организации работ, заканчивающихся заданным результатом [из п. 1.2 ГОСТ 34.601-90]

Работы по развитию АС осуществляют по стадиям и этапам, применяемым для создания АС [из п. 1.3 ГОСТ 34.601-90]

Состав и правила выполнения работ на установленных настоящим стандартом стадиях и этапах определяют в соответствующей документации организаций, участвующих в создании конкретных видов АС. Перечень организаций, участвующих в работах по созданию АС, приведен в приложении 2 [из п. 1.4 ГОСТ 34.601-90]

Стадии и этапы создания АС [из разд. 2 ГОСТ 34.601-90]

Стадии и этапы создания АС [из разд. 2 ГОСТ 34.601-90]

Стадии и этапы создания АС в общем случае приведены в таблице 1.

Стадии

Этапы работ

1 Формирование требований к АС

1.1 Обследование объекта и обоснование необходимости создания АС
1.2 Формирование требований пользователя к АС
1.3 Оформление отчета о выполненной работе и заявки на разработку АС (тактико-технического задания)

2 Разработка концепции АС

2.1 Изучение объекта
2.2 Проведение необходимых научно-исследовательских работ
2.3 Разработка вариантов концепции АС, удовлетворяющего требованиям пользователя
2.4 Оформление отчета о выполненной работе

3 Техническое задание

3.1 Разработка и утверждение технического задания на создание АС

4 Эскизный проект

4.1 Разработка предварительных проектных решений по системе и ее частям
4.2 Разработка документации на АС и ее части

5 Технический проект

5.1 Разработка проектных решений по системе и ее частям
5.2 Разработка документации на АС и ее части
5.3 Разработка и оформление документации на поставку изделий для комплектования АС и (или) технических требований (технических заданий) на их разработку
5.4 Разработка заданий на проектирование в смежных частях проекта объекта автоматизации

6 Рабочая документация

6.1 Разработка рабочей документации на систему и ее части
6.2 Разработка или адаптация программ

7 Ввод в действие

7.1 Подготовка объекта автоматизации к вводу АС в действие
7.2 Подготовка персонала
7.3 Комплектация АС поставляемыми изделиями (программными и техническими средствами, программно-техническими комплексами, информационными изделиями)
7.4 Строительно-монтажные работы
7.5 Пусконаладочные работы
7.6 Проведение предварительных испытаний
7.7 Проведение опытной эксплуатации
7.8 Проведение приемочных испытаний

8 Сопровождение АС

8.1 Выполнение работ в соответствии с гарантийными обязательствами
8.2 Послегарантийное обслуживание

[из п. 2.1 ГОСТ 34.601-90]

Стадии и этапы, выполняемые организациями-участниками работ по созданию АС, устанавливаются в договорах и техническом задании на основе ГОСТ 34.601-90. Допускается исключить стадию «Эскизный проект» и отдельные этапы работ на всех стадиях, объединять стадии «Технический проект» и «Рабочая документация» в одну стадию «Технорабочий проект». В зависимости от специфики создаваемых АС и условий их создания допускается выполнять отдельные этапы работ до завершения предшествующих стадий, параллельное во времени выполнение этапов работ, включение новых этапов работ [из п. 2.2 ГОСТ 34.601-90]

Комплектность документации [из разд. 2 ГОСТ 34.201-89]

Комплектность документации [из разд. 2 ГОСТ 34.201-89]

Перечень наименований разрабатываемых документов и их комплектность на систему и ее части должен быть определен в техническом задании на создание автоматизированной системы (подсистемы).

Примечание - Комплектность проектно-сметных документов определяют в соответствии с правилами, установленными системой проектной документации для строительства (СПДС) [из п. 2.1 ГОСТ 34.201-89]

На каждый комплект должна быть составлена ведомость документов [из п. 2.2 ГОСТ 34.201-89]

Комплектность документации, обеспечивающей разработку, изготовление, приемку и монтаж технических средств, - по ГОСТ 2.102. Комплектность эксплуатационной документации на эти средства - по ГОСТ 2.601 [из п. 2.3 ГОСТ 34.201-89]

Комплектность документации на программные средства вычислительной техники - по ГОСТ 19.101 [из п. 2.4 ГОСТ 34.201-89]

При самостоятельной разработке части системы документы на нее комплектуют в соответствии с требованиями настоящего стандарта [из п. 2.5 ГОСТ 34.201-89]

Комплексные испытания [из подр. 2.3 ГОСТ 34.603-92]

Комплексные испытания [из подр. 2.3 ГОСТ 34.603-92]

Комплексные испытания АС проводят путем выполнения комплексных тестов. Результаты испытаний отражают в протоколе. Работу завершают оформлением акта приемки в опытную эксплуатацию [из п. 2.3.1 ГОСТ 34.603-92]

В программе комплексных испытаний АС или частей АС указывают:

  1. перечень объектов испытания;
  2. состав предъявляемой документации;
  3. описание проверяемых взаимосвязей между объектами испытаний;
  4. очередность испытаний частей АС;
  5. порядок и методы испытаний, в том числе состав программных средств и оборудования, необходимых для проведения испытаний, включая специальные стенды и полигоны.

[из п. 2.3.2 ГОСТ 34.603-92]

Для проведения комплексных испытаний должны быть представлены:

  1. программа комплексных испытаний;
  2. заключение по автономным испытаниям соответствующих частей АС и устранение ошибок и замечаний, выявленных при автономных испытаниях;
  3. комплексные тесты;
  4. программные и технические средства и соответствующая им эксплуатационная документация.

[из п. 2.3.3 ГОСТ 34.603-92]

При комплексных испытаниях допускается использовать в качестве исходной информацию, полученную на автономных испытаниях частей АС [из п. 2.3.4 ГОСТ 34.603-92]

Комплексный тест должен:

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

[из п. 2.3.5 ГОСТ 34.603-92]

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

После устранения недостатков проводят повторные комплексные испытания в необходимом объеме [из п. 2.3.6 ГОСТ 34.603-92]

Общие положения [из разд. 1 ГОСТ 34.603-92]

Общие положения [из разд. 1 ГОСТ 34.603-92]

Испытания АС проводят на стадии «Ввода в действие» по ГОСТ 34.601 с целью проверки соответствия создаваемой АС требованиям технического задания (ТЗ) [из п. 1.1 ГОСТ 34.603-92]

Испытания АС представляют собой процесс проверки выполнения заданных функций системы, определения и проверки соответствия требованиям ТЗ количественных и (или) качественных характеристик системы, выявления и устранения недостатков в действиях системы, в разработанной документации [из п. 1.2 ГОСТ 34.603-92]

Для АС устанавливают следующие основные виды испытаний:

  1. предварительные;
  2. опытная эксплуатация;
  3. приемочные.

Примечания:

  1. Допускается дополнительно проведение других видов испытаний АС и их частей;
  2. Допускается классификация приемочных испытаний в зависимости от статуса приемочной комиссии (состав членов комиссии и уровень его утверждения);
  3. Виды испытаний и статус приемочной комиссии устанавливают в договоре и (или) ТЗ.

[из п. 1.3 ГОСТ 34.603-92]

В зависимости от взаимосвязей испытываемых в АС объектов испытания могут быть автономные или комплексные. Автономные испытания охватывают части АС. Их проводят по мере готовности частей АС к сдаче в опытную эксплуатацию. Комплексные испытания проводят для групп, взаимосвязанных частей АС или для АС в целом [из п. 1.4 ГОСТ 34.603-92]

Для планирования проведения всех видов испытаний разрабатывают документ «Программа и методика испытаний». Разработчик документа устанавливается в договоре или ТЗ [из п. 1.5 ГОСТ 34.603-92]

Программа и методика испытаний должна устанавливать необходимый и достаточный объем испытаний, обеспечивающий заданную достоверность получаемых результатов [из п. 1.6 ГОСТ 34.603-92]

Программа и методика испытаний может разрабатываться на AC в целом, на части АС. В качестве приложения могут включаться тесты (контрольные примеры) [из п. 1.7 ГОСТ 34.603-92]

Предварительные испытания АС проводят для определения ее работоспособности и решения вопроса о возможности приемки AC в опытную эксплуатацию [из п. 1.8 ГОСТ 34.603-92]

Предварительные испытания следует выполнять после проведения разработчиком отладки и тестирования поставляемых программных и технических средств системы и представления им соответствующих документов о их готовности к испытаниям, а также после ознакомления персонала АС с эксплуатационной документацией [из п. 1.9 ГОСТ 34.603-92]

Опытную эксплуатацию АС проводят с целью определения фактических значений количественных и качественных характеристик АС и готовности персонала к работе в условиях функционирования АС, определения фактической эффективности АС, корректировке (при необходимости) документации [из п. 1.10 ГОСТ 34.603-92]

Приемочные испытания АС проводят для определения соответствия АС техническому заданию, оценки качества опытной эксплуатации и решения вопроса о возможности приемки АС в постоянную эксплуатацию [из п. 1.11 ГОСТ 34.603-92]

Приемочным испытаниям АС должна предшествовать ее опытная эксплуатация на объекте [из п. 1.12 ГОСТ 34.603-92]

В зависимости от вида требований, предъявляемых к АС на испытаниях, проверке или аттестации в ней подвергают:

  1. комплекс программных и технических средств;
  2. персонал;
  3. эксплуатационную документацию, регламентирующую деятельность персонала при функционировании АС;
  4. АС в целом.

[из п. 1.13 ГОСТ 34.603-92]

При испытаниях АС проверяют:

  1. качество выполнения комплексом программных и технических средств автоматических функций во всех режимах функционирования АС согласно ТЗ на создание АС;
  2. знание персоналом эксплуатационной документации и наличие у него навыков, необходимых для выполнения установленных функций во всех режимах функционирования АС, согласно ТЗ на создание АС;
  3. полноту содержащихся в эксплуатационной документации указании персоналу по выполнению им функций во всех режимах функционирования АС согласно ТЗ на создание АС;
  4. количественные и (или) качественные характеристики выполнения автоматических и автоматизированных функций АС в соответствии с ТЗ;
  5. другие свойства АС, которым она должна соответствовать по ТЗ.

[из п. 1.14 ГОСТ 34.603-92]

Испытания АС следует проводить на объекте заказчика. По согласованию между заказчиком и разработчиком предварительные испытания и приемку программных средств АС допускается проводить на технических средствах разработчика при создании условий получения достоверных результатов испытаний [из п. 1.15 ГОСТ 34.603-92]

Допускается последовательное проведение испытаний и сдача частей АС в опытную и постоянную эксплуатацию при соблюдении установленной в ТЗ очередности ввода АС в действие [из п. 1.16 ГОСТ 34.603-92]

Опытная эксплуатация [из разд. 3 ГОСТ 34.603-92]

Опытная эксплуатация [из разд. 3 ГОСТ 34.603-92]

Опытную эксплуатацию проводят в соответствии с программой, в которой указывают:

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

[из п. 3.1 ГОСТ 34.603-92]

Во время опытной эксплуатации АС ведут рабочий журнал, в который заносят сведения о продолжительности функционирования АС, отказах, сбоях, аварийных ситуациях, изменениях параметров объекта автоматизации, проводимых корректировках документации и программных средств, наладке технических средств. Сведения фиксируют в журнале с указанием даты и ответственного лица. В журнал могут быть занесены замечания персонала по удобству эксплуатации АС [из п. 3.2 ГОСТ 34.603-92]

По результатам опытной эксплуатации принимают решение о возможности (или невозможности) предъявления частей АС и системы в целом на приемочные испытания.

Работа завершается оформлением акта о завершении опытной эксплуатации и допуске системы к приемочным испытаниям [из п. 3.3 ГОСТ 34.603-92]

Приемочные испытания [из разд. 4 ГОСТ 34.603-92]

Приемочные испытания [из разд. 4 ГОСТ 34.603-92]

Приемочные испытания проводят в соответствии с программой, в которой указывают:

  1. перечень объектов, выделенных в системе для испытаний и перечень требований, которым должны соответствовать объекты (со ссылкой на пункты ТЗ);
  2. критерии приемки системы и ее частей;
  3. условия и сроки проведения испытаний;
  4. средства для проведения испытаний;
  5. фамилии лиц, ответственных за проведение испытаний;
  6. методику испытаний и обработки их результатов;
  7. перечень оформляемой документации.

[из п. 4.1 ГОСТ 34.603-92]

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

  1. техническое задание на создание АС;
  2. акт приемки в опытную эксплуатацию;
  3. рабочие журналы опытной эксплуатации;
  4. акт завершения опытной эксплуатации и допуска АС к приемочным испытаниям;
  5. программа и методика испытаний.

Приемочные испытания следует проводить на функционирущем объекте [из п. 4.2 ГОСТ 34.603-92]

Приемочные испытания в первую очередь должны включать проверку:

  1. полноты и качества реализации функций при штатных, предельных, критических значениях параметров объекта автоматизации и в других условиях функционирования АС, указанных в ТЗ;
  2. выполнения каждого требования, относящегося к интерфейсу системы;
  3. работы персонала в диалоговом режиме;
  4. средств и методов восстановления работоспособности АС после отказов;
  5. комплектности и качества эксплуатационной документации.

[из п. 4.3 ГОСТ 34.603-92]

Проверку полноты и качества выполнения функций АС рекомендуется проводить в два этапа. На первом этапе проводят испытания отдельных функций (задач, комплексов задач). При этом проверяют выполнение требований ТЗ к функциям (задачам, комплексам задач). На втором этапе проводят проверку взаимодействия задач в системе и выполнение требований ТЗ к системе в целом [из п. 4.4 ГОСТ 34.603-92]

По согласованию с заказчиком проверка задач в зависимости от их специфики может проводиться автономно или в составе комплекса. Объединение задач при проверке в комплексах целесообразно проводить с учетом общности используемой информации и внутренних связей [из п. 4.5 ГОСТ 34.603-92]

Проверку работы персонала в диалоговом режиме проводят с учетом полноты и качества выполнения функций системы в целом. Проверке подлежит:

  1. полнота сообщений, директив, запросов, доступных оператору, и их достаточность для эксплуатации системы;
  2. сложность процедур диалога, возможность работы персонала без специальной подготовки;
  3. реакция системы и ее частей на ошибки оператора, средства сервиса.

[из п. 4.6 ГОСТ 34.603-92]

Проверка средств восстановления работоспособности АС после отказов ЭВМ должна включать:

  1. проверку наличия в эксплуатационной документации рекомендаций по восстановлению работоспособности и полноту их описания;
  2. практическую выполнимость рекомендованных процедур;
  3. работоспособность средств автоматического восстановления функций (при их наличии).

[из п. 4.7 ГОСТ 34.603-92]

Проверку комплектности и качества эксплуатационной документации следует проводить путем анализа документации на соответствие требованиям нормативно-технических документов и ТЗ [из п. 4.8 ГОСТ 34.603-92]

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

  1. назначение испытаний и номер раздела требований ТЗ на АС, по которому проводят испытание;
  2. состав технических и программных средств, используемых при испытаниях;
  3. указание методик, в соответствии с которыми проводились испытания, обработка и оценка результатов;
  4. условия проведения испытаний и характеристики исходных данных;
  5. средства хранения и условия доступа к конечной, тестирующей программе;
  6. обобщенные результаты испытаний;
  7. выводы о результатах испытаний и соответствии созданной системы или ее частей определенному разделу требований ТЗ на АС.

[из п. 4.9 ГОСТ 34.603-92]

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

Работу завершают оформлением акта о приемке АС в постоянную эксплуатацию [из п. 4.10 ГОСТ 34.603-92]

Правила оформления [из разд. 3 ГОСТ 34.602-89]

Правила оформления [из разд. 3 ГОСТ 34.602-89]

Разделы и подразделы ТЗ на АС должны быть размещены в порядке, установленном в разд. 2 настоящего стандарта [из п. 3.1 ГОСТ 34.602-89]

ТЗ на АС оформляют в соответствии с требованиями ГОСТ 2.105 на листах формата A4 по ГОСТ 2.301 без рамки, основной надписи и дополнительных граф к ней. Номера листов (страниц) проставляют, начиная с первого листа, следующего за титульным листом, в верхней части листа (над текстом, посередине) после обозначения кода ТЗ на АС [из п. 3.2 ГОСТ 34.602-89]

Значения показателей, норм и требований указывают, как правило, с предельными отклонениями или максимальным и минимальным значениями. Если эти показатели, нормы, требования однозначно регламентированы НТД, в ТЗ на АС следует приводить ссылку на эти документы или их разделы, а также дополнительные требования, учитывающие особенности создаваемой системы. Если конкретные значения показателей, норм и требований не могут быть установлены в процессе разработки ТЗ на АС, в нем следует сделать запись о порядке установления и согласования этих показателей, норм и требований:

«Окончательное требование (значение) уточняется в процессе... и согласовывается протоколом с... на стадии...».

При этом в текст ТЗ на АС изменений не вносят [из п. 3.3 ГОСТ 34.602-89]

На титульном листе помещают подписи заказчика, разработчика и согласующих организаций, которые скрепляют гербовой печатью. При необходимости титульный лист оформляют на нескольких страницах. Подписи разработчиков ТЗ на АС и должностных лиц, участвующих в согласовании и рассмотрении проекта ТЗ на АС, помещают на последнем листе. Форма титульного листа ТЗ на АС приведена в приложении 2. Форма последнего листа ТЗ на АС приведена в приложении 3 [из п. 3.4 ГОСТ 34.602-89]

При необходимости на титульном листе ТЗ на АС допускается помещать установленные в отрасли коды, например: гриф секретности, код работы, регистрационный номер ТЗ и др. [из п. 3.5 ГОСТ 34.602-89]

Титульный лист дополнения к ТЗ на АС оформляют аналогично титульному листу технического задания. Вместо наименования «Техническое задание» пишут «Дополнение № ... к ТЗ на AC ... » [из п. 3.6 ГОСТ 34.602-89]

На последующих листах дополнения к ТЗ на АС помещают основание для изменения, содержание изменения и ссылки на документы, в соответствии с которыми вносятся эти изменения [из п. 3.7 ГОСТ 34.602-89]

При изложении текста дополнения к ТЗ следует указывать номера соответствующих пунктов, подпунктов, таблиц основного ТЗ на АС и т. п. и применять слова: «заменить», «дополнить», «исключить», «изложить в новой редакции» [из п. 3.8 ГОСТ 34.602-89]

Страницы

«Техническая документация»

Связь по эл. почте admin @ tdocs . su (без пробелов), тел. +7(967) 044-84-77 или в форме Контакты.

Copyright © «Техническая документация» 2008. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика