Документирование ПО

Кафедра программной инженерии

Специальность: Программная инженерия

Преподаватель: Кузенкова Г.В.

Освоение дисциплины «Документирование ПО» необходимо для формирования профессиональных компетенций в области разработки, внедрения и сопровождения программного обеспечения.

Целями освоения дисциплины являются: формирование у студентов представления о процессе создания документации как важной части в разработке программного обеспечения.

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

Содержание

  1. Введение. Цели задачи дисциплины. Понятие документирования. Цели и принципы документирования программных средств. Проблемы организации документирования программных средств.
  2. Принципы выбора стратегии документирования ПО. Виды документации при создании программного обеспечения, этапы документирования: особенности создания.
  3. Стандарты документирования программного обеспечения. Государственные и международные стандарты, их обозначение. Классификаторы стандартов. Госты 19 и 34, международные стандарты, стандарты организации. Отечественный подход к документированию ПО. ЕСПД и её содержание. ЕСПД: структура или группы стандарта, достоинства и недостатки.
  4. Системы документирования. Организация документирования программного обеспечения. Подходы к созданию ТД. Концепция единого источника. Обзор систем управления версиями при разработке ПО. Управление документированием этапов жизненного цикла программного обеспечения. Документация управления качеством программного обеспечения. Структура и содержание документов по этапам жизненного цикла программного обеспечения. Технологическая и эксплуатационная документация на программное обеспечение. Техническое задание на проектирование. Общие требования к содержанию и оформлению. Особенности эскизного, технического, рабочего проекта программного обеспечения. Документирование программного кода. Инструменты для измерения кода. Пакеты программ для формирования документации на бумажном носителе. Офисные приложения. Обзор программ и платформ. Основные понятия и определения. Издательские системы.
  5. Этап тестирования ПО. Методы тестирования. Автоматическое тестирование программ. О документации тестирования компонентов и комплексов программ. Некоторые особенности разработки пользовательского интерфейса.
  6. Состав пользовательской документации на программное обеспечение. Требования к разработке. Этап создания маркетинговой документации. О брендинге при разработке ПО. Особенности фирменного стиля и документация.

Лабораторный практикум

  • Практическая работа №1. Составление плана документирования процесса разработки ПО в рамках выпускной бакалаврской работы.
  • Практические работы №2. Создание технического задания на разработку ПО в рамках учебного проекта.
  • Практические работы №3. Управление версиями разработки (на примере GitHub). Документирование программного кода.
  • Практические работы № 4. Разработка программы тестирования ПО. Документирование результатов тестирования.
  • Практические работы № 5. Разработка пользовательской документации (руководство оператора, руководство пользователя) в рамках проекта.

Литература

а) основная литература:

  1. Вендров А.М. Проектирование программного обеспечения экономических информационных систем: Учебник для вузов.- М.: Финансы и статистика, 2006.
  2. Рэшка Д., Дастин Э., Пол Д. Тестирование программного обеспечения: внедрение, управление и эксплуатация. – Бостон [и др.]: Лори, 2013.
  3. Кузенкова Г.В. Документирование ПО. [Электронный управляемый курс, система электронного обучения ННГУ] – URL: http://e-learning.unn.ru/course/view.php?id=1660

б) дополнительная литература:

  1. Липаев В. В. Методы обеспечения качества крупномасштабных программных средств. – М.: Синтег, 2003. – 520 с. 1 экз
  2. Сериков А. Введение в UML. Курс ИНТУИТ. – URL: http://www.intuit.ru/studies/higher_education/3406/courses/229/info
  3. Сериков А. Верификация программного обеспечения. Курс ИНТУИТ. – URL: http://www.intuit.ru/studies/higher_education/3406/courses/209/info
  4. Каталог действующих национальных стандартов . Информационный портал по стандартизации Федерального агентства по техническому регулированию и метрологии. – URL: http://standard.gost.ru/wps/portal, вход свободный.

в) программное обеспечение и Интернет-ресурсы:

  1. Липаев В. Стандарты, регламентирующие жизненный цикл сложных программных комплексов. http://www.pcweek.ru/themes/detail.php?ID=47815?ID=47815
  2. Клиент git: http://git-scm.com/downloads
  3. Иванов Д., Новиков Ф. Моделирование на UML: Учебно-методическое пособие. - СПб.: СПбГУ ИТМО, 2010. - 200 с. Информационная система "Единое окно доступа к образовательным ресурсам" [Электронный ресурс] – URL: http://window.edu.ru/resource/745/72745/
  4. Рудаков, А.В.   Технология разработки программных продуктов: Учебник / А.В. Рудакова. - 6-е изд., стереотип.- М.: Академия, 2012 – 208c. – URL: http://www.academia-moscow.ru/ftp_share/_books/fragments/fragment_16649.pdf

Отчетность

  • Семестр 7: Зач