где А=643 – код России (ISO), В – код организации-разработчика (ОКПО, для лабораторной работы - ГУТ), ССССС – регистрационный номер программного продукта (для лабораторной работы - номер зачетной книжки), DD- номер редакции документа (если документ существует в одной редакции, то DD не указывается.
ЕЕ- код документа, ЕЕ=12 – текст программы, ЕЕ=13 – описание программы, ЕЕ=32 – руководство программиста, ЕЕ=34 – руководство оператора.
FF – номер документа данного вида, G – номер части документа (если документ состоит из одной части, то G не указывается).
Пример. 643. ГУТ.088013 13 01 - обозначение документа "Описание программы".
Пример оформления титульного листа приведен в приложении Ж.
2.2 Текст программы
Документ "Текст программы" содержит:
- Титульный лист;
- Аннотация (необязательно);
- Содержание (необязательно);
- Основная часть;
- Лист регистрации изменений.
Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.
|
|
Допускается вводить наименование также и для совокупности разделов.
Каждый из этих разделов реализуется одним из типов символической записи, например:
символическая запись на исходном языке;
символическая запись на промежуточных языках;
символическое представление машинных кодов и т. п.
В символическую запись разделов рекомендуется включать комментарии, которые могут отражать, например, функциональное назначение, структуру.
2.3 Описание программы
Документ "Описание программы" содержит:
Титульный лист
Аннотация
Содержание
Основная часть
Общие сведения
Обозначение и наименование программы
Программное обеспечение, необходимое для функционирование программы
Языки программирования, на которых написана программа
Функциональное назначение
Классы решаемых задач
Назначение программы
Сведения о функциональных ограничениях на применение
Описание логической структуры
Алгоритм программы
Используемые методы
Структура программы с описанием функций составных частей и связи между ними
Связи программы с другими программами
Используемые технические средства
Вызов и загрузка
Способ вызова программы с соответствующего носителя данных
Входные точки в программу
Входные данные
Характер, организация и предварительная подготовка входных данных
Формат, описание и способ кодирования входных данных
|
|
Выходные данные
Характер и организация выходных данных
Формат, описание и способ кодирования выходных данных
Регистрация изменений
2.4 Руководство программиста
Документ "Руководство программиста" содержит:
Титульный лист
Аннотация
Содержание
Основная часть
Назначение и условия применения программ
Назначение программы
Функции, выполняемые программой
Условия, необходимые для выполнения программы
Объем оперативной памяти
Требования к составу периферийных устройств
Требования к параметрам периферийных устройств
Требования к программного обеспечению
Требования к персоналу (программисту)
Характеристика программы
Описание основных характеристик программы
Временные характеристики программы
Режим работы программы
Средства контроля правильности выполнения программы
Описание основных особенностей программы
Самовосстанавливаемость программы
Обращение к программе
Загрузка и запуск программы
Выполнение программы
Выполнение функции (такой-то)
Выполнение функции (этакой)
Завершение работы программы
Входные и выходные данные
Организации используемой входной информации
Организации используемой выходной информации
Сообщения
Сообщение (такое-то)
Сообщение (этакое)
Приложения (необязательны)
Регистрация изменений
2.5 Руководство оператора
Документ "Руководство оператора" содержит:
Титульный лист
Аннотация
Содержание
Основная часть
Назначение программы
Функциональное назначение программы
Эксплуатационное назначение программы
Состав функций
Функции (такой-то)
Функции (этакой)
Условия выполнения программы
Минимальный состав аппаратных средств
Минимальный состав программных средств
Требования к персоналу (пользователю)
Выполнение программы
Загрузка и запуск программы
Выполнение программы
Выполнение функции (такой-то)
Выполнение функции (этакой)
Завершение работы программы
Сообщения оператору
Сообщение (такое-то)
Сообщение (этакое)
Приложения (необязательны)
Регистрация изменений
Порядок выполнения работы
1) Пользуясь средствами MS Office разработать и оформить указанные выше программные документы для корпоративной ИС ИУС-ГУТ.
2) Пользуясь документом "Руководство программиста", изменить текст программы таким образом, чтобы в состав ИС были включены все листы разработанных в лабораторной работе программных документов для ИС "Корпоративная ИС ИУС-ГУТ".
Содержимое отчета
Отчет должен содержать:
1. Результаты разработки и оформления программных документов: спецификация, текст программы, описание программы, руководство программиста, руководство оператора Разработанные документы должны быть собраны в том 2 "КорпоративнаяИС ИУС-ГУТ", программная документация.
2. Скриншоты (изображение экранов монитора) отдельных WEB- страниц с программными документами
3. Записанный на флэшке, готовый для демонстрации набор WEB- страниц, требуемой структуры с доступными для просмотра программными документами.
Приложение Ж
ПРИМЕР ЗАПОЛНЕНИЯ ТИТУЛЬНОГО ЛИСТА
УТВЕРЖДЕН
ГУТ.088013 - ЛУ
Корпоративная ИС ИУС-ГУТ
|
|
Программный модуль
Описание программы
643. ГУТ.088013 13 01
Листов 9
2013