Скачати 79.66 Kb.
|
В начале было Слово…Библия, Новый завет,От Иоанна святое благовествованиеЛекция 13 ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СРЕДСТВ 13.1. Документация, создаваемая и используемая в процессе разработки программных средств. При разработке ПС создается и используется большой объем разнообразной документации. Она необходима как средство передачи информации между разработчиками ПС, как средство управления разработкой ПС и как средство передачи пользователям информации, необходимой для применения и сопровождения ПС. На создание этой документации приходится большая доля стоимости ПС. Эту документацию можно разбить на две группы [13.1]:
Документы управления разработкой ПС (software process documentation) управляют и протоколируют процессы разработки и сопровождения ПС, обеспечивая связи внутри коллектива разработчиков ПС и между коллективом разработчиков и менеджерами ПС (software managers) лицами, управляющими разработкой ПС. Эти документы могут быть следующих типов [13.1]:
Документы, входящие в состав ПС (software product documentation), описывают программы ПС как с точки зрения их применения пользователями, так и с точки зрения их разработчиков и сопроводителей (в соответствии с назначением ПС). Здесь следует отметить, что эти документы будут использоваться не только на стадии эксплуатации ПС (в ее фазах применения и сопровождения), но и на стадии разработки для управления процессом разработки (вместе с рабочими документами) во всяком случае, они должны быть проверены (протестированы) на соответствие программам ПС. Эти документы образуют два комплекта с разным назначением:
^ Пользовательская документация ПС (user documentation) объясняет пользователям, как они должны действовать, чтобы применить разрабатываемое ПС [13.1, 13.2.]. Она необходима, если ПС предполагает какое-либо взаимодействие с пользователями. К такой документации относятся документы, которыми должен руководствоваться пользователь при инсталляции ПС (при установке ПС с соответствующей настройкой на среду применения ПС), при применении ПС для решения своих задач и при управлении ПС (например, когда разрабатываемое ПС будет взаимодействовать с другими системами). Эти документы частично затрагивают вопросы сопровождения ПС, но не касаются вопросов, связанных с модификацией программ. В связи с этим следует различать две категории пользователей ПС: ординарных пользователей ПС и администраторов ПС. ^ ПС (end-user) использует ПС для решения своих задач (в своей предметной области). Это может быть инженер, проектирующий техническое устройство, или кассир, продающий железнодорожные билеты с помощью ПС. Он может и не знать многих деталей работы компьютера или принципов программирования. Администратор ПС (system administrator) управляет использованием ПС ординарными пользователями и осуществляет сопровождение ПС, не связанное с модификацией программ. Например, он может регулировать права доступа к ПС между ординарными пользователями, поддерживать связь с поставщиками ПС или выполнять определенные действия, чтобы поддерживать ПС в рабочем состоянии, если оно включено как часть в другую систему. Состав пользовательской документации зависит от аудиторий пользователей, на которые ориентировано разрабатываемое ПС, и от режима использования документов. Под аудиторией здесь понимается контингент пользователей ПС, у которого есть необходимость в определенной пользовательской документации ПС [13.2]. Удачный пользовательский документ существенно зависит от точного определения аудитории, для которой он предназначен. Пользовательская документация должна содержать информацию, необходимую для каждой аудитории. Под режимом использования документа понимается способ, определяющий, каким образом используется этот документ. Обычно пользователю достаточно больших программных систем требуются либо документы для изучения ПС (использование в виде инструкции), либо для уточнения некоторой информации (использование в виде справочника). В соответствии с работами [13.1, 13.2] можно считать типичным следующий состав пользовательской документации для достаточно больших ПС:
Как уже говорилось ранее (см. лекцию 4), разработка пользовательской документации начинается сразу после создания внешнего описания. Качество этой документации может существенно определять успех ПС. Она должна быть достаточно проста и удобна для пользователя (в противном случае это ПС, вообще, не стоило создавать). Поэтому, хотя черновые варианты (наброски) пользовательских документов создаются основными разработчиками ПС, к созданию их окончательных вариантов часто привлекаются профессиональные технические писатели. Кроме того, для обеспечения качества пользовательской документации разработан ряд стандартов (см. например, [13.2]), в которых предписывается порядок разработки этой документации, формулируются требования к каждому виду пользовательских документов и определяются их структура и содержание.
Документация по сопровождению ПС (system documentation) описывает ПС с точки зрения ее разработки. Эта документация необходима, если ПС предполагает изучение того, как оно устроена (сконструирована), и модернизацию его программ. Как уже отмечалось, сопровождение это продолжающаяся разработка. Поэтому в случае необходимости модернизации ПС к этой работе привлекается специальная команда разработчиков-сопроводителей. Этой команде придется иметь дело с такой же документацией, которая определяла деятельность команды первоначальных (основных) разработчиков ПС, с той лишь разницей, что эта документация для команды разработчиков-сопроводителей будет, как правило, чужой (она создавалась другой командой). Чтобы понять строение и процесс разработки модернизируемого ПС, команда разработчиков-сопроводителей должна изучить эту документацию, а затем внести в нее необходимые изменения, повторяя в значительной степени технологические процессы, с помощью которых создавалось первоначальное ПС. Документация по сопровождению ПС можно разбить на две группы:
Документация первой группы содержит итоговые документы каждого технологического этапа разработки ПС. Она включает следующие документы:
Документы установления достоверности ПС включают, прежде всего, документацию по тестированию (схема тестирования и описание комплекта тестов), но могут включать и результаты других видов проверки ПС, например, доказательства свойств программ. Для обеспечения приемлемого качества этой документации полезно следовать общепринятым рекомендациям и стандартам [13.3 - 13.8]. Документация второй группы содержит
Общая проблема сопровождения ПС обеспечить, чтобы все его представления шли в ногу (оставались согласованными), когда ПС изменяется. Чтобы этому помочь, связи и зависимости между документами и их частями должны быть отражены в руководстве по сопровождению, и зафиксированы в базе данных управления конфигурацией. Упражнения к лекции 13. 13.1. Что такое менеджер программного средства? 13.2. Что такое ординарный пользователь программного средства? 13.3. Что такое администратор программного средства? 13.4. Что такое руководство по инсталляции программного средства? 13.5. Что такое руководство по управлению программным средством? 13.6. Что такое руководство по сопровождению программного средства? Литература к лекции 13. 13.1. Ian Sommerville. Software Engineering. - Addison-Wesley Publishing Company, 1992. P.
|
![]() | Компьютерная поддержка разработки и сопровождения программных средств Инструментальные среды и инструментальные системы поддержки разработки программных средств, их классификация. Компьютерная технология... | ![]() | Архитектура программного средства Понятие архитектуры и задачи ее описания. Основные классы архитектур программных средств. Взаимодействие между подсистемами и архитектурные... |
![]() | Лекция источники ошибок в программных средствах Понятия о простых и сложных системах, о малых и больших системах. Неправильный перевод информации из одного представления в другое... | ![]() | Краткие указания к выполнению лабораторной работы с помощью программных средств ms excel Построить линейное уравнения парной регрессии y = a + bx по паре (y, х2) экономических показателей, анализируемых в самостоятельной... |
![]() | 1. Информационные системы и технологии, их классификация. Информационная система управления Информационная система управления — совокупность информации, экономико-математических методов и моделей, технических, программных,... | ![]() | Общие принципы разработки программных средств Понятие качества программного средства. Обеспечение надежности основной мотив разработки программного средства. Методы борьбы со... |
![]() | Управление разработкой и аттестация программного средства Структура управления разработкой программных средств. Подходы к организации бригад разработчиков. Управление качеством программного... | ![]() | Тарифный план по региону Удмуртская Республика г. Ижевск Стоимость... Стоимость лицензии на право использования программных продуктов «Астрал Отчет» (ндс не облагается) |
![]() | 5 контроль и регулирование деятельности по оценке автотранспортных... Проблемы оценщиков связаны с недобросовестной конкуренцией на рынке услуг по оценке автотранспортных средств, с разнообразием методического... | ![]() | Рабочая программа составлена на основе требований Государственного... Субд, языковых средств, средств автоматизации проектирования бд, современных технологий организации бд |