![]()
|
|||||||
Документирование программных средствСтр 1 из 3Следующая ⇒ Документирование программных средств
ГОСТ 19.101-77 (Виды программ и программных продуктов) ГОСТ 19.103-77 (Обозначение программ и программных документов) ГОСТ 19.104-78 (Основные надписи) ГОСТ 19.105-78 (Общие требования к программным документам) ГОСТ 19.106-78 (Общие требования к программным документам, выполненным печатным способом) ГОСТ 19.604-78 (Правила внесения изменений в прогаммные документы, выполненные печатным способом)
Описание программы (ГОСТ 19.402.78)
Оно ориентированно на документирование результирующего продукта разработки. В пояснительную записку можно взять схему алгоритма, общее описание функционирование программы, обоснование принятых технических и технико-экономических решений. Описание программы должно обязательно включать информационную часть, аннатацию и содержание. Основная часть документа состоит из - водной части - раздел Функциональное назначение; - раздел Описание логики; - раздел Условное применение; - раздел Состав и функции. Пример В вводной части Программа «Автоматизированное рабочее место…» предназначена для …. Реализована на … Программа поддерживает …
В разделе назначение Программа предназначена для решения задач… Программа представляет собой ядро автоматизированного рабочего места… Пользователь имеет возможность … Осуществить… Запустить… Проанализировать… Получить результаты анализа и обработки… Построить ….
В разделе описание логики указывают Описание структуры программы и ее составных частей В состав программы входит следующее: - Пользовательский интерфейс, - Модуль определения путей в графе, - Модуль расчета передаточной функции, - Модуль построения амплитудно и фазочастотных характеристик, - Модуль построения реакции на полиномиальное воздействие, - Текстовый редактор. Описание функций составных частей и связей между ними Программа состоит из …. модулей: - Интерфейсный модуль - Модуль определения - Модуль расчета - Модуль… Интерфейсный модуль построен на двух типах диалогов: 1. диалог «вопрос-ответ» 2. диалог типа меню. Выходные данные Выходными данными является: 1. выводимая на экран графическая и текстовая информация (результаты анализа системы); 2. файлы в одном из графическом формате – копии изображения построенных характеристик. 3. Текстовые файлы – отчеты о проведенных исследованиях. 4. Диагностика состояния системы и сообщения о всех возникающих ошибках. 5. Описание логики составных частей (при необходимости следует составлять описание схем программ). В разделе Условия применения Указываются условия, необходимые для выполнения программы (требования к необходимости для данной программы техническим средствам, и другим программам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера и т.п.)
Программа эксплуатируется на ПК IBM PC/AT. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа «мышь». Для поддержки графического режима необходим адаптер EGA (VGA). Входные данные хранятся на флэш и ил жестком диске. Программа работает под управлением ОС… Необходимо указать имя загрузочного модуля, а также всей процедуры вызова и загрузки системы. Загрузка программы осуществляется набором в командной строке .DOS имени загрузочного модуля – SSXX/EXE. С возможным указанием имени файла данных.
В разделе состав и функции Указывают описание состава и функции программ, применяемых методов решения задачи.
Текст программы(ГОСТ 19.401-78) Требования к оформлению текста программы достаточно просты и естественны для грамотного программиста. Основное чем требуется руководствоваться при создании этого доку4мента – это, то что текст программы должен быть удобочитаемым. Обязательным является составление информационной части – аннотации и содержания. Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования. Текст каждого программного файла начинается с «шапки», в которой указывается: - Наименование программы; - Автор; - Дата создания программы; - Номер версии; - Дата последней модификации. Обязательными являются комментарии, а также строгое соблюдение правил отступа.
Программа методики испытаний (ГОСТ 19.301-79) В этом документе содержится описание того, что и как необходимо сделать, дабы убедиться (и убедить заказчика) в правильности работы программы. Документ содержит описание объекта и цели испытаний, требования к программе и к программной документации, средства и порядок испытаний., а также описание тестовых примеров. Составные части этого документа: 1. Объект испытаний
|
|||||||
|