Акционерное общество Научно-инженерный центр Санкт-Петербургского электротехнического университета Документирование программного обеспечения Докладчик: Пудова Анастасия Михайловна
Жизненный цикл информационной системы (программной системы) §Проектирование §НИР §ЭП §Разработка §ТП ØБизнес-анализ ØПроектирование интерфейса § пользователя ØПроектирование архитектуры § ГОСТ 34. 601 -90 § Автоматизированные § системы. Стадии создания §Разработка РКД ØНепрерывная интеграция ØРазработка базы данных ØРазработка кода ØРазработка графического контента для УТС ØТестирование ØОформление документации §Ввод в эксплуатацию §Сопровождение 2
Определение, категории Документация на ПО – это комплект документов, сопровождающий ПО (описывает, как ПО нужно использовать, какие функции ПО выполняет, условия, необходимые для работы ПО и т. д) Технический писатель - специалист, занимающийся документированием в рамках решения технических задач, в частности разработки ПО Основная задача технического писателя — написание документов, которые должны удовлетворять определённым требованиям 3
Категории документации на ПО üпрограммная документация (ПД) – документация, содержащая сведения, необходимые для разработки, эксплуатации, изготовления и сопровождения ПО; üэксплуатационная документация (ЭД) – документация, необходимая для обеспечения функционирования и эксплуатации ПО. Именно эксплуатационная документация поставляется Заказчику 4
Исходные данные для документирования ПО Исходными данными являются: Ø техническое задание (ТЗ) - документ, который устанавливает основное назначение разрабатываемого ПО, его технические характеристики, показатели качества и технико-экономические требования (согласуется с Заказчиком); Ø разработанное ПО; Ø материалы от разработчика ПО (описание структуры ПО, use-case, постановки задач и т. д) 5
Руководящие документы для документирования ПО Документация разрабатывается в соответствии с требованиями: Ø ЕСПД (единая система программной документации) – комплекс государственных стандартов (ГОСТ) 19 серии, устанавливающих правила разработки, оформления и обращения ПО и ПД. Например: Ø ГОСТ 19. 101 -77 – виды программных документов; Ø ГОСТ 19. 103 -77 – обозначение программных документов; Ø ГОСТ 19. 104 -78 – оформление листа утверждения, титульного листа; Ø ГОСТ 19. 106 -78 – оформление текстовой части документа; Ø СТП (стандарт предприятия) – расширения, уточнения ГОСТ; Ø РД (руководящий документ) «Защита от несанкционированного доступа к информации. Часть 1. Программное обеспечение средств защиты информации. Классификация по уровню контроля отсутствия недекларированных возможностей» 6
Типовой комплект документов на ПО Типовой комплект документации на ПО: Ø ведомость эксплуатационных документов* (ГОСТ 19. 507 -79); Ø формуляр* (ГОСТ 19. 501 -78); Ø описание применения* (ГОСТ 19. 502 -78); Ø руководство системного программиста* (ГОСТ 19. 503 -79); Ø руководство программиста* (ГОСТ 19. 504 -79); Ø руководство оператора* (ГОСТ 19. 505 -79); Ø спецификация (ГОСТ 19. 202 -78); Ø текст программы (ГОСТ 19. 401 -78); Ø описание программы (ГОСТ 19. 402 -78); Ø программа и методика испытаний (ГОСТ 19. 301 -79); Ø пояснительная записка (ГОСТ 19. 404 -79) * - эксплуатационный документ (поставляется Заказчику) 7
Требование к документированию ПО Требованию к содержательной части: üдостоверность (документация соответствует ПО); üполнота (описаны все возможности ПО); üнепротиворечивость; üотсутствие избыточной информации; üединая терминология; Требования к оформлению: üединый стиль оформления (заголовки, шрифты, отступы и т. д); üединый подход к описанию; üсоответствие ЕСПД (оформление текста, таблиц, рисунков, надписей и т. д) 8
Выполнение требований к документированию ПО Для выполнения части требований к разработке документации используются: Ø шаблон документа (в Microsoft Word) – это документ формата. dot (. dotx). Использование шаблона обеспечивает: Ø единый стиль оформления документов; Ø соответствие требованиям ЕСПД, СТП; Ø база знаний (Wiki) – это единый источник, который используют в своей работе все участники проектной команды (для описания ПО) 9
Качество документации – что это дает? Качественная документация позволяет: ü для пользователя: ü быстро осваивать ПО; ü устанавливать, обновлять ПО самостоятельно; üдля разработчика: ü сократить количество вопросов от пользователя; ü легко сопровождать; ü сократить количество замечаний при сертификации; ü упростить процесс согласования с Заказчиком 10
Представление информации в документации на ПО Документы содержат следующие виды информации: Текстовая информация Графическая информация Формулы Диаграммы, схемы 11
Инструменты для разработки документации на ПО При разработке ПО используются следующие инструменты и средства: ü Microsoft Office ( Word, Visio); ü разработанные шаблоны. dot (. dotx) на каждый документ; ü средства работы с изображениями ( paint, другие редакторы изображений); ü средства работы с формулами (equation, mathtype, другие редакторы формул) 12
Этапы документирования ПО При документировании ПО проводится: üознакомление с предметной областью; üознакомление с ПО; ü получение материалов о ПО; ü проектирование структуры изложения материалов, обеспечивает: ü обеспечивает простоту изучения документа; ü облегчает поиск информации; ü описание содержательной части; ü оформление документов; ü проверка документации что 13
Использование терминологии 10 % 60 % 40 % 14
Проектирование структуры изложения материала От задач пользователя От функций ПО 15
Способы изложения материала Изложение с точки зрения пользователя 16
Способы изложения материала Изложение с точки зрения функций ПО 17
Взаимодействие с проектной командой тестировщик архитектор программист технический писатель аналитик 18
Жизненный цикл документации после разработки бюро стандартизации 1. ПД 2. + ПД 3. Дистрибутив ПО + ПД 4. представительство Заказчика Дистрибутив ПО + ПД отдел технического контроля Дистрибутив ПО бюро технической документации 19
Система поддержки разработки документации 20
Технический писатель – с кем общается тестировщик программист аналитик архитектор технический писатель бюро стандартизации отдел технического контроля представительство бюро технической документации Заказчика 21
Передача документации заказчику + Изготовление ЭД Дистрибутив ПО Заказчик 22
Технический писатель – каким должен быть Личные качества: Ø внимательность; Ø ответственность; Ø коммуникабельность; Ø умение быстро разобраться с ПО Знания и навыки: Ø грамотность; Ø уверенный пользователь компьютера; Ø навыки работы с программами (Microsoft Word); Ø умение грамотно излагать свои мысли 23
Спасибо за внимание! Вопросы? 24
Скачать презентацию Акционерное общество Научно-инженерный центр Санкт-Петербургского электротехнического университета Документирование
62bda529e2bbe6863daff2bb1f456d62.ppt