2.4. Спецификация. Требования к содержанию и оформлению
ГОСТ 19.101-77 определяет программный документ "Спецификация" как состав программы и документации на нее. Согласно ГОСТ 19.202-78 программный документ "Спецификация" должен состоять из титульной, основной части и части регистрации изменений. Информационная часть (аннотация и содержание) в данном документе является необязательной.
Основная часть в общем случае содержит разделы: документация, комплексы и компоненты. В разделе "Документация" перечисляются программные документы, подготовленные в курсовой работе. Разделы "Комплексы" и "Компоненты" отражают структуру программы.
Заполнение части регистрации изменений такое же, как и в остальных программных документах.
Форма заполнения спецификации приведена на рисунке 11. В графе "Обозначение" запись производят в одну строку. В остальных графах спецификации записи допускаются в несколько строк. Наименование каждого раздела спецификации указывают в графе "Наименование".
В раздел "Документация" вносятся обозначения подготовленных на данный программный продукт документов, кроме документа "Спецификация" в порядке возрастания кода вида документа, входящего в обозначение документа. В разделе "Наименование" указывается наименование программного продукта и вид документа. В графу "Примечания" заносятся дополнительные сведения, относящиеся к записанным в спецификации документам.
Разделы "Комплексы" и "Компоненты" являются необязательными при подготовке документа "Спецификация". Пример заполнения основной части программного документа "Спецификация" приведен в Приложении 2.
25
10
Обозначение
Наименование
Примечание
80 70 30
20 10
297
15
210
Рисунок 11 - Расположение и форма основной части документа
"Спецификация" на формате стандартного листа
Литература
1. Единая система программной документации. М., Государственный комитет СССР по стандартам, 1982.
2. Уолш Д. Руководство по созданию документации для математического обеспечения. М., Наука, 1980.
3. Майерс Г. Надежность программного обеспечения. М., Мир. 1980.
4. Ван Тассел Д. Стиль, разработка, эффективность, отладка и испытание программ. 2-е изд., испр., М., Мир. 1985.
5. Гласс Р. Руководство по надежному программированию. М., Финансы и статистика, 1982.
6. Лингер Р., Миллс Х., Уитт Б. Теория и практика структурного программирования. М., Мир. 1982.
Содержание
1. Виды программных документов и устанавливающие их ГОСТы. . . . . . . . . . . . . 3
2. Рекомендации по содержанию основной части программных документов . . . . .9
2.1. Текст программы. Требования к содержанию и оформлению . . . . . . . . . . . 9
2.2. Описание программы. Требования к содержанию и оформлению . . . . . . . 14
2.3. Описание применения. Требования к содержанию и оформлению .. . . . . . .18
2.4. Спецификация. Требования к содержанию и оформлению . .. . . . . . . . . . . .20
Литература . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Приложение 1. Список ГОСТов Единой Системы Программной Документации ..23
Приложение 2. Пример заполнения основной части программного документа "Спецификация" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Приложение 3. Основные элементы графического изображения схем алгоритмов . и программ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Приложение 1