Студопедия

Главная страница Случайная страница

КАТЕГОРИИ:

АвтомобилиАстрономияБиологияГеографияДом и садДругие языкиДругоеИнформатикаИсторияКультураЛитератураЛогикаМатематикаМедицинаМеталлургияМеханикаОбразованиеОхрана трудаПедагогикаПолитикаПравоПсихологияРелигияРиторикаСоциологияСпортСтроительствоТехнологияТуризмФизикаФилософияФинансыХимияЧерчениеЭкологияЭкономикаЭлектроника






Виды программных документов.

 

К программным относят документы, содержащие сведения, необходимые для разработки, сопровождения и эксплуатации программного обеспечения. Документирование программною обеспечения осуществляется в соответствии с Единой системой программной документации (ГОСТ 19.XXX). Так ГОСТ 19.101-77 устанавливает виды программных документов для программного обеспечения различных типов. Ниже перечислены основные программные документы по этому стандарту и указано, какую информацию они должны содержать.

 

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

 

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

 

Текст программы (код вида документа - 12) должен содержать текст программы с необходимыми комментариями. Необходимость этого документа определяете я на папе разработки и утверждения технического задания.

 

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

 

Ведомость эксплуатационных документов (код вида документа - 20) должна содержать перечень эксплуатационных документов на программу, к которым относятся документы с кодами: 30, 31, 32, 33, 34. 35. 46. Необходимость этого документа также определяется на этапе разработки и утверждения технического задания.

 

Формуляр (код вида документа - 30) должен содержать основные характеристики ПО, комплектность и сведения об эксплуатации программы.

 

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

 

Руководство системного программиста (код вида документа - 32) должно содержать сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения.

 

Руководство программиста (код вида документа - 33) должно содержать сведения для эксплуатации программного обеспечения.

 



Руководство оператора (код вида документа - 34) должно содержать сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программного обеспечения.

 

Описание языка (код вида документа - 35) должно содержать описание синтаксиса и семантики языка.

 

Руководство по техническому обслуживанию (код вида документа - 46) должно содержать сведения для применения тестовых и диагностических программ при обслуживании технических средств.

 

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

 

Пояснительная записка (код вида документа - 81) должна содержать информацию о структуре и конкретных компонентах ПО, в том числе схемы алгоритмов, их общее описание, а также обоснование принятых технических и технико-экономических решении. Составляется стадии эскизного и технического проекта.

 

Прочие документы (код вида документа - 90 - 99) могут составляться на любых стадиях разработки, т.е. на стадиях эскизного, технического и рабочего проектов.

 

Код вида документа указывается в его децимальном номере, например:

 

42333253.00037-01 34 01 (руководство оператора).

 

Допускается объединять отдельные виды эксплуатационных документов, кроме формуляра и ведомости. Необходимость объединения указывается в техническом задании, а имя берут у одного из объединяемых документов. Например, в настоящее время часто используется эксплуатационный документ, в который отчасти входит руководство системного программиста, программиста и оператора. Он называется «Руководство пользователя».



 

Рассмотрим наиболее важные программные документы более подробно.

 

Руководство пользователя

 

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

 

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

 

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

 

-излагайте ясно, используйте короткие предложения;

 

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

 

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

 

Руководство пользователя, как правило, содержит следующие разделы:

 

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

 

-описание установки;

 

-описание запуска;

 

-инструкции по работе (или описание пользовательского интерфейса);

 

-сообщения пользователю.

 

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

 

Раздел Установка обычно содержит подробное описание действий по установке программного продукта и сообщений, которые при этом могут быть получены.

 

В разделе Запуск, как правило, описаны действия по запуску ПО и сообщений, которые при этом могут быть получены.

 

Раздел Инструкции по работе обычно содержит описание режимов работы, форматов ввода-вывода информации и возможных настроек.

 

Раздел Сообщения пользователю должен содержать перечень возможных сообщений, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.

 

Руководство системного программиста

 

По ГОСТ 19.503-79 руководство системного программиста должно содержать всю информацию, необходимую для установки ПО, его настройки и проверки работоспособности. Кроме того в него часто включают и описание необходимого обслуживания, которое раньше приводилось в руководстве оператора (ГОСТ 19.505-79) и/или руководстве по техническому обслуживанию (ГОСТ 19.508-79). В настоящее время данную схему используют для составления руководства системному администратору.

 

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

 

-общие сведения о программе;

 

-структура программы;

 

-настройка;

 

-проверка;

 

-дополнительные возможности;

 

-сообщения системному программисту.

 

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

 

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

 

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

 

В разделе Проверка программы должно быть приведено описание способов проверки работоспособности программы, например контрольные примеры.

 

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

 

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

 

Виды эксплуатационных документов и их содержание


  • Ведомость эксплуатационных документов (код вида документа - 20) - содержит перечень эксплуатационных документов на программу.

  • Формуляр (код вида документа - 30) - содержит основные характеристики программы, комплектность и сведения об эксплуатации программы.

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

  • Руководство системного программиста (код вида документа - 32) - содержит сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения.

  • Руководство программиста (код вида документа - 33) - содержит сведения для эксплуатации программы .

  • Руководство оператора (код вида документа - 34) - содержит сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы .

  • Описание языка (код вида документа - 35) - содержит описание синтаксиса и семантики языка.

  • Руководство по техническому обслуживанию (код вида документа - 46) - содержит сведения для применения тестовых и диагностических программ при обслуживании технических средств.


Помимо оговариваемых стандартом, на программу могут выпускаться и другие программные и эксплуатационные документы, им присваиваются коды от 90 до 99.

 

Виды и содержание документации по ЕСПД на этапах разработки технического задания.

Документация при проектировании и разработке ПС.

Для представления и детализации структуры и содержания технологической документации ЖЦ ПС целесообразно разделить на этапы:


  1. системный анализ и проектирование ПС – разработка и интегрирование программных компонентов

  2. тестирование компонентов и комплексов программ

  3. испытание ПС

  4. сопровождение и конфигурационное управление версиями ПС.

 

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

Аннотацию и содержание допускается в документ не включать.

Техническое задание должно содержать следующие разделы:


  1. Введение - наименование, краткая характеристика, область применения программы и объекта, в котором используют программу.

  2. Основание для разработки - документ/документы, на основании которых ведется разработка; организация, утвердившая этот документ, и дата его утверждения; наименование и/или условное обозначение темы разработки.

  3. Назначение разработки - функциональное и эксплуатационное назначение программы.

  4. Требования к программе или программному изделию - раздел должен содержать следующие подразделы:

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

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

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

    • Требования к составу и параметрам технических средств - необходимый состав технических средств с указанием их основных технических характеристик.

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

    • Требования к маркировке и упаковке - требования к маркировке программного изделия, варианты и способы упаковки.

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

    • Специальные требования.

  5. Требования к программной документации - предварительный состав программной документации и, при необходимости, специальные требования к ней.

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

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

  8. Порядок контроля и приемки - виды испытаний и общие требования к приемке работы.


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


  1. В приложениях к техническому заданию, при необходимости, приводят:

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

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

  • другие источники разработки.


Этот стандарт устанавливает стадии разработки программ, программной документации, а также этапы и содержание работ:

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


Примечания:


  1. Допускается исключать вторую стадию разработки, а в технически обоснованных случаях — вторую и третью стадии. Необходимость проведения этих стадий указывается в техническом задании.

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

 

<== предыдущая лекция | следующая лекция ==>
Тактика защиты вратаря | Местность.

mylektsii.ru - Мои Лекции - 2015-2019 год. (0.015 сек.)Все материалы представленные на сайте исключительно с целью ознакомления читателями и не преследуют коммерческих целей или нарушение авторских прав Пожаловаться на материал