Программная документация

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

Сюда относятся документы, имеющие отношение как к созданию системы, так и к созданию ПО.

Техническая и программная документация состоит из следующих разделов:

1. Титульная часть.

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

3. Основная часть

4. Регистрация изменений.

Титульная часть состоит из листа утверждения и титульного листа. Правила утверждения определены соответствующим гостом.

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

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

В техническом задании (документ) должны содержаться следующие разделы:

1. Наименование и область применения

2. Основание для разработки

3. Назначение разработки

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

5. Технико-экономические показатели

6. Стадии и этапы разработки

7. Порядок контроля и приемки

8. Приложения

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

Содержание раздела «Технические требования».

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

Содержание раздела может видоизменяться.

В приложениях ТЗ при необходимости указывают:

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

Описание программ.

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

В разделе «описание логики» приводится описание структуры программы и её составных частей. Описываются функции основных частей и связи между ними. Сведения о языках программирования. Описание входных и выходных данных для каждой составной части. Описание логики составных частей. В приложении выносится текст программы. При описании программы необходима привязка к её тексту. На размеры документации (технической) ограничения нигде не указываются. Размер может быть от нескольких страниц для простых систем до многих томов для сложных. Главное – лаконичность и предельная ясность.

Не нашли, что искали? Воспользуйтесь поиском: