Студопедия

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

Разделы сайта

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






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






(ГОСТ 19.106-78 – изучить на сайте)

 

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

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

Виды программ и программных документов для ЭВМ комплексов и систем независимо от их назначения и области применения установлены ГОСТ 19.101-77 и ГОСТ 19.781-90 (сайт).

Стандарты ЕСПД (как и другие ГОСТы) подразделяют на группы, приведенные в следующей таблице

Код группы Наименование группы
  Общие положения
  Основополагающие стандарты
  Правила выполнения документации разработки
  Правила выполнения документации изготовления
  Правила выполнения документации сопровождения
  Правила выполнения эксплуатационной документации
  Правила обращения программной документации
  Резервные группы
 
  Прочие стандарты

 

Обозначение стандарта ЕСПД строят по классификационному признаку. Обозначение стандарта состоит из:

1) числа 19 (просвоенному классу стандартов ЕСПД)

2) одной цифры (после точки), обозначающей код классификационной группы стандартов, указанной в таблице;

3) двузначного числа (после тире), указывающего год регистрации стандарта

 

Документация для разработки ПО:

ТЕХНИЧЕСКОЕ ЗАДАНИЕ (ГОСТ 19.201-78) содержит основание для разработки, назначение разработки, требования к программе, требования к программной документации, технико-экономические показатели, стадии и этапы разработки, порядок контроля и приемки.

СПЕЦИФИКАЦИЯ (ГОСТ 19.202-78) содержит перечень и краткое описание назначения всех файлов программного обеспечения, в том числе и файлов документации на него. Является обязательной для программных систем, а также их компонентов, имеющих самостоятельное применение.

 

Документация для изготовления ПО:

ПРОГРАММА И МЕТОДИКА ИСПЫТАНИЙ (ГОСТ 19.301-79, код – 51) включает:

1) сведения об области применения испытуемой программы;

2) определенную и достижимую цель испытания;

3) требования:

· к комплектности программной документации,

· характеристикам программы применительно к условиям эксплуатации,

· к информационной и программной совместимости;

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

Приводятся описания применяемых методов испытаний с указанием

конкретных проверок и результатов этого испытания. Во всех случаях

при применении теста необходимо четко определить конкретные значе-

ния входных данных, ожидаемые выходные и промежуточные результаты.

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

включены тестовые примеры, их контрольные распечатки, аналитические

и другие материалы. Мы включаем это в ПД «Текст программы».

 

К эксплутационной документации относятся документы, которыми руководствуется при инсталляции, применении и управлении программным средством.

Это:

ФОРМУЛЯР (ГОСТ 19.501-78, код документа - 30) содержит основные характеристики ПО, комплектность и сведения об эксплуатации программы.

ОПИСАНИЕ ПРИМЕНЕНИЯ (ГОСТ 19.502-78, код документа - 31) содержит сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств, описание входных и выходных данных.

РУКОВОДСТВО СИСТЕМНОГО ПРОГРАММИСТА (ГОСТ 19.503-79, код - 32) содержит сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения с учетом используемых технических и вспомогательных системных программных средств.

РУКОВОДСТВО ПРОГРАММИСТА (ГОСТ 19.504-79, код - 33) содержит все сведения, необходимые для сопровождения программы.

В РУКОВОДСТВЕ ОПЕРАТОРА (ГОСТ 19.505-79, код 34) дается вся необходимая информация для обеспечения процедуры общения (взаимодействия) оператора с вычислительной системой в процессе выполнения программы.

ОПИСАНИЕ ЯЗЫКА (ГОСТ 19.506-79, код – 35) должно содержать описание синтаксиса и семантики языка.

РУКОВОДСТВО ПО ТЕХНИЧЕСКОМУ ОБСЛУЖИВАНИЮ (ГОСТ

19.508-79, код – 46) должно содержать сведения для применения тестовых и диагностических программ при обслуживании технических средств и ПО.

ВЕДОМОСТЬ ЭКСПЛУАТАЦИОННЫХ ДОКУМЕНТОВ (ГОСТ 19.507-79, код - 20) должна содержать перечень эксплуатационных документов на программу, к которому относятся документы с кодами 30, 31, 32, 33, 34, 35, 46

Документация для сопровождения ПО:

ТЕКСТ ПРОГРАМЫ ГОСТ (ГОСТ 19.401-78, код документа – 12) состоит из символических записей на исходном языке с подробными комментариями, которые должны составлять около 30% текста программы. Рекомендуется в комментариях описывать назначение программы, основные особенности алгоритма отдельных участков, особенности ввода-вывода и т.д.

ОПИСАНИЕ ПРОГРАММЫ (ГОСТ 19.402-78, код документа -13) включает:

- наименование программы,

- язык программирования,

- ПО, необходимое для функционирования программы,

- логическое строение, состоящее из:

1) алгоритмов модулей,

2) используемых методов,

3) структуры программы с описанием функций составных частей (модулей) и связи между ними,

4) связей программы с другими программами.

Здесь содержатся разделы: " Используемые технические средства",

где указаны типы ЭВМ и устройств, необходимых для эксплуатации прог-

раммы, " Входные и выходные данные" (характер, организация, предва-

рительная подготовка (для входных данных), формат способ кодирования

данных.

 

ВЕДОМОСТЬ ДЕРЖАТЕЛЕЙ ПОДЛИННИКОВ (ГОСТ 19.403-79, код документа - 05) содержит список предприятий, на которых хранятся подлинники программных документов.

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА (ГОСТ 19.404-79, код - 81) содержит информацию о структуре и конкретных компонентах ПО, в т.ч. схемы алгоритмов, подробное описание алгоритма функционирования программы, а также обоснование принятых технических и экономических решений.

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

• введение;

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

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

• ожидаемые технико-экономические показатели;

• источники, используемые при разработке.

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

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

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

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

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

• описание и обоснование выбора способа организации входных и выходных данных;

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

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

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

 

ГОСТ 19.701-90 - Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения

 

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

Материалы каждого программного документа располагаются в следующей последовательности (ГОСТ 19.105-78):

1) Титульная часть (ГОСТ 19.104-78):

- лист утверждения (не входит в общее число листов)

- титульный лист (первый лист документа)

2) Информационная часть:

- аннотация (сведения о назначении документа и краткое изложение его основной части);

- листы содержания.

3) Основная часть:

- текст документа с рисунками и таблицами;

- приложения;

- перечень терминов;

- перечь сокращений;

- перечень рисунков;

- перечень таблиц;

и т.д.

4) Часть регистрации изменений:

- лист регистрации изменений (см. заставу

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

 






© 2023 :: MyLektsii.ru :: Мои Лекции
Все материалы представленные на сайте исключительно с целью ознакомления читателями и не преследуют коммерческих целей или нарушение авторских прав.
Копирование текстов разрешено только с указанием индексируемой ссылки на источник.