Практическая работа № 22.
Оформление документации на программные средства с использованием инструментальных средств
Цель работы: разработать комплект документации на программное средство.
Краткие теоретические сведения
Программное документирование – это процесс записи информации, произведенной процессами жизненного цикла.
Процесс содержит набор действий, которые планируют, проектируют, разрабатывают, производят, редактируют, распространяют и сопровождают те документы, в которых нуждаются все заинтересованные лица, такие как менеджеры, инженеры и пользователи программного средства.
Общие требования к составу и содержанию документов, поддерживающих создание программных средств, представлены в ряде стандартов разного ранга. Состав документов широко варьируется в зависимости от класса и характеристик объекта разработки.
Существует несколько стандартов в области обеспечения документирования программных средств.
ISO12207 -Информационные технологии. Процессы жизненного цикла программного обеспечения.
В этом стандарте документированию посвящен специальный раздел в группе вспомогательных процессов.
ISO9000-3-Общееруководствокачествоми стандартыпообеспечениюкачества.
Управлению качеством документации посвящен специальный раздел 6.2. Эти задачи отраженытакже вряде разделовстандарта, непосредственнорегламентирующих управление качеством сложных программных средств.
ISO6592 –Обработка информации. Руководство по разработке документации для вычислительных систем
Главная цель этого стандарта состоит в установлении базисной структуры документации, на основе которой возможно для любого проекта обеспечить эффективное совершенствование и реализацию информационной системы, ПС или БД. В стандарте установлены руководящие принципы создания документов для информационных систем.
ISO9294 -Информационные технологии. Руководящие положения по управлению документацией на программное обеспечение
ТехническийотчетэтогостандартапредставляетруководствоподокументированиюПС для руководителей, отвечающих за создание программной продукции. Руководство предназначено для помощи в управлении разработкой и эффективном документировании программных проектов.
IEEE1063-1993-Пользовательскаядокументациянапрограммноеобеспечение.
+В нем представлены наиболее полно общие требования к пользовательской документации на программные средства широкого применения. Стандарт определяет минимальные требования к структуре и содержанию комплекта документов для пользователей программных продуктов.
ГОСТ 34.602—89 Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы Настоящий стандарт распространяется на автоматизированные системы для автоматизации различных видов деятельности (управление, проектирование, исследование и т.п.), включая их сочетания, и устанавливает состав, содержание, правила оформления документа “Техническое задание на создание (развитие или модернизацию) системы”.
ГОСТ Р 51904-2002 — Программное обеспечение встроенных систем. Общие требования к разработке и документированию.
Стандартраспространяетсянапроцессыразработкиидокументированияпрограммного обеспечения встроенных систем реального времени. Стандарт распространяется на все действия, имеющие отношение к разработке программного обеспечения.
ГОСТ19.101–Видыпрограммипрограммныхдокументов.
Настоящий стандарт устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения. Виды программных документов и их содержание приведены в таблице 1:
Таблица 19
Вид программного документа | Содержание программного документа |
Спецификация | Состав программы и документации на нее |
Ведомость держателей подлинников | Перечень предприятий, на которых хранят подлинники программных документов |
Текст программы | Запись программы с необходимыми комментариями |
Описание программы | Сведения о логической структуре и функционировании программы |
Программа и методика испытаний | Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля |
Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
Эксплуатационные документы | Сведения для обеспечения функционирования и эксплуатации программы |
Порядок выполнения работы:
Оформить пояснительную записку (ПЗ) на программный продукт. ПЗнапрограммноесредстводолжнаиметьследующуюструктуру:
Постановка задачи;
Входные и выходные данные;
Среда разработки и обоснование выбора языка программирования;
Описание алгоритма;
Описание используемых классов и методов;
Заключение.
Приложение A–Техническое задание; Приложение Б – Технический проект;
Приложение В–Иерархия функциональных диаграмм. Диаграмма сущность-связь.
Диаграмма потоков данных Приложение Г UML-диаграммы
Приложение Д Листинг программы
Содержание отчета: ПЗ на электронном и бумажном носителе.
Контрольные вопросы:
Что такое техническая документация и какие её основные виды?
Каковы основные стандарты оформления документации?