про. МетодичкаВнедрениеКСПрРаб. Методические указания по выполнению практических работ обучающихся по учебной

• Название: Методические указания по выполнению практических работ обучающихся по учебной
• Дата: 25.09.2022
• Размер: 132.31 Kb.
• Имя файла: МетодичкаВнедрениеКСПрРаб.docx
• Тип: Методические указания; #694676
• страница: 4 из 14

Практическая работа № 3

Тема Разработка (подготовка) документации и отчетных форм для внедрения программных средств

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

Теоретические сведения

При разработке программных средств (ПС) создается и используется большой объем разнообразной документации.

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

На создание этой документации приходится большая доля стоимости программного средства.

Эту документацию можно разбить на две группы:

1. 
   документы управления разработкой программного средства;
   
2. 
   документы, входящие в состав программного средства.
   

Документы управления разработкой ПС управляют и протоколируют процессы разработки и сопровождения ПС, обеспечивая связи внутри коллектива разработчиков ПС и между коллективом разработчиков и менеджерами ПС - лицами, управляющими разработкой ПС.

Эти документы могут быть следующих типов:

• 
  планы, оценки, расписания;
  
• 
  отчеты об использовании ресурсов в процессе разработки;
  
• 
  стандарты;
  
• 
  рабочие документы;
  
• 
  заметки и переписка.
  

Документы, входящие в состав ПС, описывают программы ПС как с точки зрения их применения пользователями, так и с точки зрения их разработчиков и сопроводителей. Эти документы будут использоваться не только на стадии эксплуатации ПС, но и на стадии разработки для управления процессом разработки (вместе с рабочими документами).

Эти документы образуют два комплекта с разным назначением:

• 
  пользовательская документация ПС (П-документация).
  
• 
  документация по сопровождению ПС (С-документация).
  

Пользовательскаядокументацияпрограммныхсредств

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

К такой документации относятся документы, которыми должен руководствоваться пользователь при инсталляции, при применении для решения своих задач и при управлении.

Эти документы частично затрагивают вопросы сопровождения, но не касаются вопросов, связанных с модификацией программ.

Можно считать типовым составом следующий состав пользовательской документации для достаточно больших ПС:

• 
  общее функциональное описание;
  
• 
  руководство по инсталляции;
  
• 
  инструкция по применению;
  
• 
  справочник по применению;
  
• 
  руководство по управлению.
  

Документацияпосопровождениюпрограммных средств

Документация по сопровождению описывает ПС с точки зрения ее разработки. Эта документация необходима, если ПС предполагает изучение того, как оно устроено (сконструировано), и модернизацию его программ.

Документация по сопровождению ПС можно разбить на две группы:

1. 
   документацию, определяющую строение программ и структур данных ПС и технологию их разработки;
   
2. 
   документацию, помогающую вносить изменения в ПС.
   

Документация первой группы содержит итоговые документы каждого технологического этапа разработки ПС.

Она включает следующие документы:

• 
  внешнее описание ПС;
  
• 
  описание архитектуры ПС, включая внешнюю спецификацию каждой ее программы (подсистемы).
  
• 
  для каждой программы ПС описание ее модульной структуры, включая внешнюю спецификацию каждого включенного в нее модуля;
  
• 
  для каждого модуля спецификацию и описание его строения;
  
• 
  тексты модулей на выбранном языке программирования;
  
• 
  документы установления достоверности ПС.
  

Документация второй группы содержит руководствопосопровождениюПС, которое описывает особенности реализации ПС.

В нем также фиксируются, какие части ПС являются аппаратно- и программно-зависимыми.

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

Создание и использование пакета прикладных программ (ППП) от формирования концепции и требований к первой версии до изъятия его из эксплуатации сопровождается документированием объектов и процессов жизненного цикла ППП.

ПосвоемуназначениюдокументациюПППможноклассифицировать

как:

1. 
   технологическую документацию процесса разработки,
   

включающую подробные технические описания для специалистов, ведущих проектирование, разработку и сопровождение ППП, обеспечивающую возможность отчуждения, детального освоения, развития и корректировки ими программ и баз данных на всем жизненном цикле ППП;

2. 
   эксплуатационную (пользовательскую) документацию программного продукта, создаваемую для конечных пользователей пакета и позволяющую им осваивать и квалифицированно применять его для решения конкретных прикладных задач.
   

Технологическаядокументациявключает:

• 
  проектную документацию;
  
• 
  документацию тестирования компонентов и комплексов про- грамм;
  
• 
  документацию испытаний ППП;
  
• 
  документацию сопровождения и управления конфигурацией
  

ППП.

Всоставпроектнойдокументации входят:

• 
  отчет по обследованию предметной области, для которой
  

предназначен разрабатываемый ППП, с описанием комплекса задач;

• 
  описание концепции проектирования;
  
• 
  техническое задание на проектирование;
  
• 
  план-график работ;
  
• 
  спецификации эскизного и технического проекта;
  
• 
  документация на разработанные программные модули пакета;
  
• 
  общее описание программного обеспечения, используемого при разработке и функционировании пакета.
  

Всоставдокументациитестированиявходят:

• 
  исходные данные для проведения тестирования (методы тестирования, тестовые наборы, эталонные значения, реальные ресурсы тестирования - временные, аппаратно-программные, людские, критерии полноты и качества тестирования);
  
• 
   программа (сценарии) тестирования;
  
• 
  журнал тестирования;
  
• 
  итоговый отчет о результатах тестирования.
  

Всоставдокументациииспытанийвходят:

• 
  программа испытаний;
  
• 
  описание методов и методик испытаний;
  
• 
  протоколы испытаний;
  
• 
  акт завершения работ;
  
• 
  акт приемки ППП в эксплуатацию.
  

В состав документации сопровождения управления конфигу-рацией входят:

• 
  отчеты пользователей о выявленных дефектах и предложения по корректировке программ;
  
• 
  журнал выявленных дефектов и предложений по совершенствованию и развитию версии ППП;
  
• 
  журнал подготовленных и утвержденных корректировок, а также реализованных изменений в новой версии пакета;
  
• 
  отчет о результатах эксплуатации снятой с сопровождения версии пакета;
  
• 
  журнал тиражирования и характеристик базовых версий, поддерживаемых сопровождением.
  

Пользовательскаядокументациявключаетв себя:

• 
  паспорт на программное средство;
  
• 
  общее описание информационной системы (ИС), в составе которой будет использоваться ППП;
  
• 
  руководство администратора программного средства,
  
• 
  руководства оперативных пользователей с требованиями к уровню подготовки пользователя, описание функций.