Калайда В.Т., Романенко В.В. Технология разработки программного обеспечения (2007), страница 35

Основное внимание сосредотачивает на оценке потребности в оборудовании и других средствах, которые понадобятся впроцессе разработки. Так как в этот период закупки не производятся, роль этой группы ограничивается лишь участием. Никаких документов она не утверждает.Таблица 8.5 — Участие группы обслуживания в фазовых обзорахФазаИсследованиеАнализосуществимостиКонструированиеПрограммированиеОценкаИспользованиеФазовыйобзорIIIФорма участия приобсуждении документовРассмотрениеРассмотрение и утверждениеIIIIVVVIНе участвуетРассмотрениеРассмотрениеРассмотрениеВ фазовом обзоре II группа обслуживания ведет переговоры о приобретении оборудования и других материалов для проведения испытаний класса C и распространения программного изделия. Она также рассматривает и планирует растущий объем услуг229в конфигурационном управлении, защите прав собственности, ведении документации и управлении сопровождением.Группа обслуживания не участвует в фазовом обзоре III,однако в промежутках между фазами II и IV она рассматривает иутверждает план испытаний, чтобы убедиться в соответствииэтих документов требованиям испытаний класса C.

Она такжеизучает и утверждает обязательства по обеспечению испытанийаппаратурой и другими средствами в соответствии с планом испытаний.За исключением управления планами и утверждения календарных планов, группа обслуживания не принимает участия вдругих обзорах. Администратор планирования рассматривает соглашение о требованиях в фазе II, конфигуратор — в фазах III, IVи V и календарный план — в фазах I—IV.

Здесь он выступает вроли консультанта и поэтому не участвует в утверждении.8.5 Организация выпуска документацииТермины «документация» и «справочные материалы» относятся к печатной продукции, предназначенной для пользователей программного изделия. Термин «документы» используется по отношению к планам и спецификациям, которые изготавливаются для сотрудников, участвующих в проектировании.Следует различать рекламные и справочные материалы, т.к. онипредназначены для разных категорий пользователей и при ихсоздании ставятся разные цели.Рекламные материалы предназначены преимущественнодля административного персонала, в то время как справочныематериалы используются операторами, программистами и системными аналитиками.

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

Централизация планирования ивыпуска документации играет важную роль в обеспечении согласованности различных материалов по программному изделию. Эти цели можно достичь, создав такое организационноеподразделение, в котором могут работать бригады редакторов ипроизводственные бригады.Редакторы могут быть прикреплены к конкретномупроекту и иметь различные служебные полномочия как в рамках функции выпуска документации, так и по отношению копекаемым ими группам разработчиков.

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

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

8.8 — Организационная структура группы выпуска документацииКомплектование производственной бригады не вызываетпроблем, однако найти редакторов очень нелегко. Трудно (илиневозможно) заставить переквалифицироваться программистана редактора, еще труднее филолога обучить писать материалыпо программному изделию. Высокая стоимость подготовки рукописей по программному изделию заставляет руководителейдавать преимущества производственного роста именно редакторам, тем самым привлекая программистов к этой работе.8.5.2 Стандарты и практические руководстваЕсли не установить правила оформления документации,редакторы, художники и т.п., подобно программистам, будутдействовать в зависимости от своих вкусов и наклонностей.Чтобы продукция имела профессиональный вид, следует начатьс подбора соответствующих стандартов.232Одним из важнейших стандартов является руководствопо стилю.

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

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

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

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

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

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

В этом документеописываются все сообщения, порождаемые программой, а также ситуации, в которых они возникают, инеобходимые действия оператора. Указатель составляется, в основном, по листингам программ и предназначен для операторов, программистов и системныханалитиков.В интерактивном режиме появляется возможность оперативно выводить справочную информацию на экран. В таких системах выдается большое количество сообщений — подсказок исообщений об ошибках. Группа разработки проектирует лишьпрограммный механизм подобного взаимодействия, ответствен-234ность за окончательную реализацию текстов сообщений, ихстиль и форматы несет группа выпуска документации.