Лекция 6. Тема_6_Лекция_1. 2. 1 Назначение технической документации

• Название: 2. 1 Назначение технической документации
• Анкор: Лекция 6
• Дата: 12.01.2023
• Размер: 36.2 Kb.
• Имя файла: Тема_6_Лекция_1.docx
• Тип: Регламент; #883432

2.1 Назначение технической документации

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

Комплекс технических документов, который регламентирует деятельность разработчиков, называется нормативно-методическим обеспечением (НМО). В данный комплекс входят [2]:

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

НМО регламентирует порядок разработки, общие требования к составу и качеству программного обеспечения (ПО), связям между компонентами, определяет содержание проектной и программной документации.

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

Таким образом, можно выделить следующие функции технической документации:

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

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

1. 
   что и зачем должно быть документировано?
   
2. 
   для кого предназначен тот или иной документ?
   
3. 
   какие ошибки может допустить пользователь и что нужно сделать для их устранения?
   
4. 
   как и в каких условиях будет использоваться документ?
   
5. 
   каковы сроки разработки документа?
   
6. 
   как будет обновляться, и поддерживаться документация, каковы механизмы и сроки внесения изменений и пересмотра документов и кто ответственен за реализацию этих действий, а также за хранение, неизменность и контроль за исполнением?
   
7. 
   кто будет оценивать документ и как он соотносится с отраслевыми или ведомственными требованиями на сертификацию разработки?
   

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

2.2. Требования к технической документации

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

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

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

Вопросы для самоконтроля:

1. Что такое нормативно-методическое обеспечение?

2. Каково основной назначение технической документации информационных систем?

3. Каковы функции технической документации?

4. В чьи обязанности входят работы по документированию информационной системы?

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

Назначение документации

Документация входит в состав проекта по созданию, внедрению, сопровождению, модернизации и ликвидации ИС на протяжении полного жизненного цикла этой ИС. Документация необходима:

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

Документация выполняет следующие функции:

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

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

К документации предъявляют следующие требования:

1. документы должны быть ясными, краткими, точными и полными;

2. для повышения эффективности работы с документами должны использоваться стандарты, регламентирующие форму, содержание и, иногда, стиль документов;

3. документация должна создаваться параллельно с разработкой ПО;

4. обязанности по документированию системы лежат на ее разработчике, создающем, модернизирующем и привлекающем в проект ИС те или иные программные средства. Особенно важна внешняя документация;

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

6. перед составлением документации необходимо иметь ответ на следующие вопросы:

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

Ответы на эти вопросы должны быть получены на ранних стадиях разработки ИС (на стадии разработки технико-экономического обоснования к ТЗ) и входить в состав разрабатываемой в рамках проекта документации.

Для повышения эффективности разработки программных изделий (ПИ), а также повышения их качества необходима стандартизация и унификация документов, описывающих как процедуры работ, так и результаты выполнения работ по созданию программного продукта. С этой целью было разработано несколько десятков отечественных государственных стандартов, из которых больше половины были стандартами в рамках Совета экономической взаимопомощи (СЭВ) бывшего содружества стран социалистического лагеря (СССР и др.), остальные – международными (ISO).

Состав программных документов по фазам ЖЦ ИС

Системная документация (классификация документов, существовавшая с 1970 по 1980 годы и не отмененная в настоящее время) по стадиям ЖЦ ИС:

постановка задачи:

1) техническое задание (ТЗ), включает в свой состав: техникоэкономическое описание проекта (ТЭО); календарный план проектирования; сметную калькуляцию проекта; каталожное описание разработки (КО), технические требования (ТТ) и технические условия (ТУ), относящиеся к проектируемому изделию и т.п.;

разработка:

2) проектная документация, в составе: проект системы; подготовка данных; разработка программы;

реализация испытаний:

3) пособия руководства: руководство пользователя; руководство по обслуживанию; руководство оператора; руководство администраторов (данных, баз данных, серверного обеспечения, сетевого обеспечения, сервера защиты и т.п.)

эксплуатация:

4) реализация: программный код; информация, вызываемая системой; тесты и тестовые прогоны программы; требования, процедуры и условия сертификации продукта.

Альтернативный состав документации, предусмотренный действующими стандартами (по стадиям ЖЦ ИС):

выработка требований:

1) требования к функциональной структуре;

2) требования к информационной структуре;

проектирование:

3) системная спецификация и описание подсистем;

4) программная спецификация;

5) спецификация БД;

6) руководство системных специалистов, администраторов;

7) руководство пользователя, план испытаний;

программирование, испытание, сертификация:

8) руководство по эксплуатации;

9) руководство по сопровождению;

Единая система программной документации (ЕСПД)

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

Различают следующие классификационные группы стандартов ЕСПД:

1) общие положения;

2) основополагающие стандарты;

3) правила выполнения документации при разработке;

4) правила выполнения документации при изготовлении;

5) правила выполнения документации при сопровождении;

6) правила выполнения документации при эксплуатации;

7) правила обращения к программной документации;

8) резервные группы;

9) прочие стандарты.

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

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

В техническом задании (ТЗ) обосновываются назначение и области применения программы, технические, технико-экономические и специальные требования, необходимые стадии и сроки разработки, виды испытаний. Каждая созданная или привлеченная в проект программа сопровождается пояснительной запиской, в которой наряду с ее обобщенным описанием приводятся схема алгоритма и общее описание алгоритма и функция программы, а также обоснование принятых решений. Эта записка входит в состав расчетно-пояснительной записки к проекту ИС.

Эксплуатационные документы содержат сведения необходимые для обеспечения функционирования и эксплуатации системы и включают в состав:

• 
  ведомость эксплуатационных документов на программу;
  
• 
  формуляр (основные характеристики, комплектность, сведения об эксплуатации);
  
• 
  описание применения (сведения о назначении, класс задач, область применения, используемые методы, организация, минимальная конфигурация технических средств, в том числе по вопросам организации АРМ пользователей, серверного хозяйства, маршрутизации, сетевого обеспечения, организации бесперебойного энергопитания, средств защиты, периферийных устройств и ТСО);
  
• 
  руководство системного программиста (сведения для проверки, обеспечения функционирования и настройки программы);
  
• 
  руководство программиста (сведения для эксплуатации программ);
  
• 
  руководство оператора (сведения для осуществления действий по выполнению программой / системой требований);
  
• 
  руководство по техническому обеспечению;
  
• 
  журнал документов;
  
• 
  руководство (инструкции) по сертификации, модернизациям, масштабированию и ликвидации ИС (АСУ) по истечении действия предусмотренного проектом полного жизненного цикла системы;
  
• 
  обучающие и учебно-методические материалы по системе, ознакомительные с ней материалы (демоверсии и их описание);
  
• 
  другие эксплуатационные документы (специального назначения), оговоренные в ТЗ.
  

Стандарты в составе ЕСПД:

• 
  ГОСТ 19.001-77. ЕСПД. Общие положения;
  
• 
  ГОСТ 19.003-80. ЕСПД. Схемы алгоритмов и программ. Обозначения условные графические. Заменен на ГОСТ 19.701-90;
  
• 
  ГОСТ 19.005-85. ЕСПД. Р-схемы алгоритмов и программ. Обозначения условные графические и правила выполнения;
  
• 
  ГОСТ 19.101-77. ЕСПД. Виды программ и программных документов;
  
• 
  ГОСТ 19.102-77. ЕСПД. Стадии разработки;
  
• 
  ГОСТ 19.103-77. ЕСПД. Обозначение программ и программных документов;
  
• 
  ГОСТ 19.104-78. ЕСПД. Основные надписи;
  
• 
  ГОСТ 19.105-78. ЕСПД. Общие требования к программным документам;
  
• 
  ГОСТ 19.106-78. ЕСПД. Требования к программным документам, выполненным печатным способом;
  
• 
  ГОСТ 19.201-78. ЕСПД. Техническое задание. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.202-78. ЕСПД. Спецификация. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.301-79. ЕСПД. Программа и методика испытаний. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.401-78. ЕСПД. Текст программы. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.402-78. ЕСПД. Описание программы;
  
• 
  ГОСТ 19.403-79. ЕСПД. Ведомость держателей подлинников;
  
• 
  ГОСТ 19.404-79. ЕСПД. Пояснительная записка. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.501-78. ЕСПД. Формуляр. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.502-78. ЕСПД. Описание применения. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.503-79. ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.504-79. ЕСПД. Руководство программиста. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.505-79. ЕСПД. Руководство оператора. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.506-79. ЕСПД. Описание языка. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.507-79. ЕСПД. Ведомость эксплуатационных документов;
  
• 
  ГОСТ 19.508-79. ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению;
  
• 
  ГОСТ 19.601-78. ЕСПД. Общие правила дублирования, учета и хранения;
  
• 
  ГОСТ 19.602-78. ЕСПД. Правила дублирования, учета и хранения программных документов, выполненных печатным способом;
  
• 
  ГОСТ 19.603-78. ЕСПД. Общие правила внесения изменений;
  
• 
  ГОСТ 19.604-78. ЕСПД. Правила внесения изменений в программные документы, выполненные печатным способом;
  
• 
  ГОСТ 19.701-90 (ИСО 5807-85). ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.
  

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

Определение и назначение технического задания

На стадии «Техническое задание» разрабатывают Техническое задание (ТЗ) на создание автоматизированной системы в соответствии с требованиями ГОСТ 34.602-89.

Техническое задание (ТЗ, техзадание) – исходный документ для проектирования сооружения или промышленного комплекса, конструирования технического устройства (прибора, машины, системы управления и т. д.), разработки информационных систем, стандартов либо проведения научно-исследовательских работ (НИР). ТЗ содержит основные технические требования, предъявляемые к сооружению или изделию и исходные данные для разработки.

ТЗ на ИС является основным документом, определяющим требования и порядок создания (развития или модернизации – далее создания) ИС, в соответствии с которым проводится разработка ИС и ее приемка при вводе в действие.

ТЗ на ИС разрабатывают на систему в целом, предназначенную для работы самостоятельно или в составе другой системы. Дополнительно могут быть

разработаны ТЗ на части ИС:

• 
  на подсистемы ИС, комплексы задач ИС и т. п. в соответствии с требованиями настоящего стандарта;
  
• 
  на комплектующие средства технического обеспечения и программно-технические комплексы в соответствии со стандартами ЕСКД и СРПП;
  
• 
  на программные средства в соответствии со стандартами ЕСПД;
  
• 
  на информационные изделия в соответствии с ГОСТ 19.201 и научно-технической документацией, действующей в ведомстве заказчика ИС.
  

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

Как правило, ТЗ составляют на основе анализа результатов предварительных исследований, расчётов и моделирования.

Как инструмент коммуникации в связке общения заказчик-исполнитель, техническое задание позволяет обеим сторонам:

• 
  представить готовый продукт;
  
• 
  выполнить по-пунктную проверку готового продукта (приёмочное тестирование – проведение испытаний);
  
• 
  уменьшить число ошибок, связанных с изменением требований в результате их неполноты или ошибочности (на всех стадиях и этапах создания, за исключением испытаний);
  

заказчику:

• 
  осознать, что именно ему нужно;
  
• 
  требовать от исполнителя соответствия продукта всем условиям, оговорённым в ТЗ;
  

исполнителю:

• 
  понять суть задачи, показать заказчику «технический облик» будущего изделия, программного изделия или автоматизированной системы;
  
• 
  спланировать выполнение проекта и работать по намеченному плану;
  
• 
  отказаться от выполнения работ, не указанных в ТЗ.
  

Разделы технического задания
ТЗ на ИС содержит нижеследующие разделы, которые могут быть разделены на подразделы.

1.Общие сведения.

1.1.Полное наименование системы и её условные обозначения.

1.2.Шифр темы или номер договора.

1.3.Наименование организации разработчика и заказчика системы.

1.4.Перечень документов, на основании которых создается система.

1.5.Плановые сроки начала и окончания работы по созданию системы.

Начало: __.__.____

Окончание: __.__.____

1.6.Порядок оформления и предъявления заказчику результатов.

2. Назначение и цели создания (развития) системы. Раздел «Назначение и цели создания (развития) системы» состоит из подразделов.

2.1.Назначение системы – указывают вид автоматизируемой деятельности (управление, проектирование и т. п.) и перечень объектов автоматизации (объектов), на которых предполагается ее использовать.

2.2.Цели создания системы – приводят наименования и требуемые значения технических, технологических, производственно-экономических или других показателей объекта автоматизации, которые должны быть достигнуты в результате создания АС, и указывают критерии оценки достижения целей создания системы. Цель в технике предусматривает положительную динамику, изменение текущего состояния чего-либо в сторону улучшения, удовлетворения определенных потребностей или требований. Измеримость цели предполагает, что по описанию цели можно легко определить, насколько ее достижение улучшит текущее состояние. Цель в технике часто ошибочно идентифицируют с задачей. Например, «цель – строительство нового многоэтажного жилого дома». На самом деле, «строительство многоэтажного жилого дома» – задача, цель – прибыль, а миссия – «повышение благосостояния граждан». Пример целей и задач создания автоматизированной системы учета:

«Целями создания автоматизированной системы учета являются:

1) повышение точности учета…;

2) снижение затрат, связанных с…;

3) повышение эффективности…;

Задачи создания автоматизированной системы учета:

1)замена устаревших приборов учета на приборы, отвечающие современным требованиям;

2) автоматизация процесса измерения учитываемых физических величин;

3)автоматизация процесса консолидации данных об измеренных величинах».

3. Характеристика объектов автоматизации.

4. Требования к системе.

4.1.Требования к системе в целом.

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

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

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

4.1.3. Показатели назначения:

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

4.1.4. Требования к надежности – требования к надежности технических средств и программного обеспечения.

4.1.5. Требования по безопасности – требования по обеспечению безопасности при эксплуатации (защита от воздействий электромагнитных полей, акустических шумов и т. п.), по допустимым уровням освещенности, вибрационных и шумовых нагрузок.

4.1.6. Требования к эргономике и технической эстетике – показатели АС, задающие необходимое качество взаимодействия человека с машиной и комфортность условий работы персонала.

4.1.7. Требования к эксплуатации, техническому обслуживанию, ремонту и хранению компонентов системы:

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

4.1.8. Требования к защите информации от несанкционированного доступа.

4.1.9. Требования по сохранности информации при авариях – приводят перечень событий: аварий, отказов технических средств (в том числе – потеря питания) и т. п., при которых должна быть обеспечена сохранность информации в системе.

4.1.10. Дополнительные требования.

4.2.Требования к функциям (задачам), выполняемым системой.

4.2.1. Перечень функций и задач по каждой подсистеме.

4.2.2. Требования к форме представления выходной информации.

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

4.3.Требования к видам обеспечения.

5. Состав и содержание работ по созданию системы.

6. Порядок контроля и приемки системы.

7. Требования к составу и содержанию работ по подготовке объекта автоматизации к вводу системы в действие.

8. Требования к документированию.

9. Источники разработки.

В подразделе 4.3. «Требования к видам обеспечения» в зависимости от вида системы приводят требования к математическому, информационному, лингвистическому, программному, техническому, метрологическому, организационному, методическому и другие видам обеспечения системы.

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

Описание информационного обеспечения содержит следующие разделы:

• 
  принципы организации ИО;
  

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

Для организационного обеспечения приводят требования:

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

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

• к защите от ошибочных действий персонала системы.

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

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