Научная электронная библиотека
Монографии, изданные в издательстве Российской Академии Естествознания

ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СРЕДСТВ

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

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

 документы управления разработкой ПС.

 документы, входящие в состав ПС.

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

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

 отчеты об использовании ресурсов в процессе разработки. Создаются менеджерами.

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

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

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

Документы, входящие в состав ПС (software product documen­ta­tion), описывают программы ПС как с точки зрения их применения пользователями, так и с точки зрения их разработчиков и сопроводителей (в соответствии с назначением ПС). Следует отметить, что эти документы будут использоваться не только на стадии эксплуатации ПС (в ее фазах применения и сопровождения), но и на стадии разработки для управления процессом разработки (вместе с рабочими документами). Во всяком случае, они должны быть проверены (протестированы) на соответствие программам ПС.

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

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

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

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

Пользовательская документация ПС (user documentation) объясняет пользователям, как они должны действовать, чтобы применить разрабатываемое ПС. Она необходима, если ПС предполагает какое-либо взаимодействие с пользователями. К такой документации относятся документы, которыми должен руководствоваться пользователь при инсталляции ПС (при установке ПС с соответствующей настройкой на среду применения ПС), при применении ПС для решения своих задач и при управлении ПС (например, когда разрабатываемое ПС будет взаимодействовать с другими системами). Эти документы частично затрагивают вопросы сопровождения ПС, но не касаются вопросов, связанных с модификацией программ.

В связи с этим следует различать две категории пользователей ПС: ординарных пользователей ПС и администраторов ПС. Ординарный пользователь ПС (end-user) использует ПС для решения своих задач (в своей предметной области). Он может не знать многих деталей работы компьютера или принципов программирования. Администратор ПС (system administrator) управляет использованием ПС ординарными пользователями и осуществляет сопровождение ПС, не связанное с модификацией программ. Например, он может регулировать права доступа к ПС между ординарными пользователями, поддерживать связь с поставщиками ПС или выполнять определенные действия, чтобы поддерживать ПС в рабочем состоянии, если оно включено как часть в другую систему.

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

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

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

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

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

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

 руководство по управлению ПС. Предназначено для администраторов ПС. Оно должно описывать сообщения, генерируемые, когда ПС взаимодействует с другими системами, и как должен реагировать администратор на эти сообщения. Кроме того, если ПС использует системную аппаратуру, этот документ может объяснять, как сопровождать эту аппаратуру.

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

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

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

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

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

 документацию, помогающую вносить изменения в ПС.

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

 внешнее описание ПС (Requirements document);

 описание архитектуры ПС (description of the system architect­ture), включая внешнюю спецификацию каждой ее программы (подсистемы).

 для каждой программы ПС описание ее модульной структуры, включая внешнюю спецификацию каждого включенного в нее модуля;

 для каждого модуля спецификацию и описание его строения (design description);

 тексты модулей на выбранном языке программирования (program source code listings);

 документы установления достоверности ПС (validation docu­ments), описывающие, как устанавливалась достоверность каждой программы ПС, и как информация об установлении достоверности связывалась с требованиями к ПС.

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

Документация второй группы содержит руководство по сопровождению ПС (system maintenance guide), которое описывает особенности реализации ПС (в частности, трудности, которые пришлось преодолевать) и как учтены возможности развития ПС в его строении (конструкции). В нем также фиксируются, какие части ПС являются аппаратно- и программно-зависимыми.

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

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

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

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

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

 проектную документацию;

 документацию тестирования компонентов и комплексов про­грамм;

 документацию испытаний ППП;

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

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

 описание концепции проектирования;

 техническое задание на проектирование;

 план-график работ;

 спецификации эскизного и технического проекта;

 документация на разработанные программные модули пакета;

 общее описание программного обеспечения, используемого при разработке и функционировании пакета (описание выбранной технологии автоматизированного проектирования ППП, операцион­ной системы, других программных средств).

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

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

 программа (сценарии) тестирования;

 журнал тестирования;

 итоговый отчет о результатах тестирования.В состав документации испытаний входят:

 программа испытаний;

 описание методов и методик испытаний;

 протоколы испытаний;

 акт завершения работ;

 акт приемки ППП в эксплуатацию.В состав документации сопровождения управления конфигу­рацией входят:

 отчеты пользователей о выявленных дефектах и предло­жения по корректировке программ;

 журнал выявленных дефектов и предложений по совершенствованию и развитию версии ППП;

 журнал подготовленных и утвержденных корректировок, а также реализованных изменений в новой версии пакета;

 отчет о результатах эксплуатации снятой с сопровождения версии пакета;

 журнал тиражирования и характеристик базовых версий, поддерживаемых сопровождением.Пользовательская документация включает в себя:

 паспорт на программное средство, где содержатся общие сведения о ППП, его основные характеристики, комплектность, акт о приемке, гарантии изготовителя (поставщика);

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

 руководство администратора программного средства, кото­рое регламентирует функции администрирования, процедуры по инсталляции и подготовке ППП к эксплуатации, порядок и средства ведения базы данных и восстановления ин­формации при сбоях;

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

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

В процессе сопровождения в програм­мы вносятся различные изменения:

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

 модернизация - расширение функциональных возможно­стей или улучшение качества решения отдельных задач в соответ­ствии с новым или дополнительным техническим заданием на ППП;

 адаптация, регламентированная документацией, к услови­ям конкретного использования, обусловленным характеристиками внешней среды или конфигурацией аппаратуры.

Выход коммерческого программного продукта на рынок про­граммных средств связан с организацией продаж массовому поль­зователю. Как правило, для каждого программного продукта существует своя форма кривой продаж, которая отражает спрос V во времени t (рис. 11).

Вначале продажа программного продукта идет вверх - возрас­тающий участок кривой. Затем наступает стабилизация. Далее происходит падение объема продаж, что является сигналом к изменению маркетинговой политики фирмы в отноше­нии данного программного продукта, требуется модификация продукта, изменение цены или снятие с продажи.

Эксплуатация программного продукта идет параллельно с его сопровождением, при этом эксплуатация программ может начи­наться и в случае отсутствия сопровождения, или продолжаться в случае завершения сопровождения еще какое-то время. После сня­тия программного продукта с продажи его сопровождение может выполняться определенное время.

Рис. 11. Кривая продаж программного продукта

Сопровождение коммерческого программного продукта произ­водится в форме устранения обнаруженных ошибок путем выпуска программных «заплаток» - патчей. Эти программы выкладываются на Web-сайте разработчика и предлагаются пользователям. Об­новление обычно происходит в автоматическом режиме при загруз­ке патча. Кроме этого, ведется и модернизация программ. В про­цессе эксплуатации фирма-разработчик предлагает пользователям приобрести новые версии программного продукта. Сопровождение также осуществляется специализированными фирмами-распро­странителями программного продукта (дистрибьюторами).

Снятие программного продукта с продажи и отказ от сопрово­ждения происходят, как правило, в случае изменения технической политики фирмы-разработчика, неэффективности работы про­граммного продукта, наличия в нем неустранимых ошибок, отсутст­вия спроса.

Длительность жизненного цикла для различных программных продуктов неодинакова. Для большинства современных программ­ных продуктов длительность жизненного цикла измеряется двумя-тремя годами. Хотя достаточно часто встречаются и давно снятые с производства программные продукты.

Существуют другие варианты легального распространения программного продукта, кроме коммерческого, которые появились с использованием глобальных или региональных сетей:freeware - бесплатно распространяемые и поддерживаемые самим пользователем программы;shareware - условно-бесплатные программы. Ими можно поль­зоваться бесплатно некоторое время, а при условиях регулярного использования требуется внести определен­ную сумму разработчику программы;demo-версии (демонстрационная и пробная програм­мы). Это версии коммерческих программ, специально подготовлен­ные разработчиком для бесплатного распространения в рекламных целях. Демонстрационная версия, как правило, рассчитана на не­ограниченное время пользования, но представляет собой урезанный вариант платной программы, то есть в ней реализованы не все функции. Пробная версия обычно полнофункциональна, но остается работоспособной лишь в течение небольшого промежутка времени, достаточного для ознакомления с ней (несколько дней или недель, либо определенное количество запусков). После этого работоспособность программы блокируется или же она превраща­ется в демонстрационную версию;ad ware - программа, показывающая рекламу. Бесплатная про­грамма такого типа, как правило, сохраняет все функции коммерче­ской версии и остается работоспособной в течение неограниченно­го времени, однако она постоянно показывает пользователю рекламные окна - баннеры. Чтобы «отключить» назойливую рек­ламу, необходимо оплатить коммерческую версию;OEM (Original Equipment Manufacturer) - программы, постав­ляемые с купленной компьютерной техникой по OEM-контракту ме­жду фирмой-разработчиком и продавцом ПК (или другого hardware). Их стоимость меньше, чем стоимость retail-программ, поставляе­мых в розницу в «коробочном» исполнении.


Предлагаем вашему вниманию журналы, издающиеся в издательстве «Академия Естествознания»
(Высокий импакт-фактор РИНЦ, тематика журналов охватывает все научные направления)

«Фундаментальные исследования» список ВАК ИФ РИНЦ = 1.074