ВУЗ: Томский государственный университет систем управления и радиоэлектроники
Категория: Учебное пособие
Дисциплина: Проектирование информационных систем
Добавлен: 21.10.2018
Просмотров: 10748
Скачиваний: 8
231
гих
обзорах.
Администратор
планирования
рассматривает
согла-
шение
о
требованиях
в
фазе
II,
конфигуратор
—
в
фазах
III,
IV
и
V
и
календарный
план
—
в
фазах
I—IV.
Здесь
он
выступает
в
роли
консультанта
и
поэтому
не
участвует
в
утверждении.
8.5
Организация
выпуска
документации
Термины
«документация»
и
«справочные
материалы»
от-
носятся
к
печатной
продукции,
предназначенной
для
пользова-
телей
программного
изделия.
Термин
«документы»
использует-
ся
по
отношению
к
планам
и
спецификациям,
которые
изготав-
ливаются
для
сотрудников,
участвующих
в
проектировании.
Следует
различать
рекламные
и
справочные
материалы,
т.к.
они
предназначены
для
разных
категорий
пользователей
и
при
их
создании
ставятся
разные
цели.
Рекламные
материалы
предназначены
преимущественно
для
административного
персонала,
в
то
время
как
справочные
материалы
используются
операторами,
программистами
и
сис-
темными
аналитиками.
Группа
поддержки
составляет
реклам-
ные
материалы
в
рамках
своей
деятельности,
связанной
со
сбы-
том,
а
изготовление
справочного
материала
входит
в
обязанно-
сти
группы
выпуска
документации.
8.5.1 Организационная структура группы выпуска
документации
Прежде
всего
очевиден
тот
факт,
что
большинство
про-
граммистов
не
любит
писать
никаких
бумаг,
кроме
программ,
поэтому
введение
специальной
группы
для
выполнения
этих
работ
достаточно
обосновано.
Централизация
планирования
и
выпуска
документации
играет
важную
роль
в
обеспечении
со-
гласованности
различных
материалов
по
программному
изде-
лию.
Эти
цели
можно
достичь,
создав
такое
организационное
подразделение,
в
котором
могут
работать
бригады
редакторов
и
производственные
бригады.
Редакторы
могут
быть
прикреплены
к
конкретному
про-
екту
и
иметь
различные
служебные
полномочия
как
в
рамках
функции
выпуска
документации,
так
и
по
отношению
к
опекае-
232
мым
ими
группам
разработчиков.
Цели
группы
выпуска
доку-
ментации
направлены
на
создание
эффективного
рабочего
взаимодействия
с
группой
разработки.
Производственные
бригады
должны
находиться
целиком
в
подчинении
группы
выпуска
документации.
Это
технические
редакторы,
машинистки,
художники,
граверы
и
др.
Для
осуществления
деятельности
группы
выпуска
доку-
ментации
важное
значение
имеет
установление
и
соблюдение
стандартов,
регулирующих
работу
редакционных
и
производст-
венных
бригад.
Создание
стандартов
обычно
поручается
одно-
му
или
нескольким
аналитикам
группы
выпуска
документации.
Положение
группы
выпуска
документации
внутри
про-
ектной
организации
зависит
от
характера
и
объема
выполняе-
мых
работ
(либо
в
отделе
сбыта,
либо
в
разрабатывающих
под-
разделениях)
(рис.
8.8).
Рис.
8.8
—
Организационная
структура
группы
выпуска
документации
Руководитель
подготовки
описания
технических
средств
Руководитель
подготовки
описания
программных
средств
Рецензент
документации
по
техническим
средствам
Руководитель
производст-
венной
бригады
Руководитель
Ответ-
ственный
редактор
Старший
редактор
Редактор
Младший
редактор
Рецензент
документации
по
программам
Художест-
венное
оформление
Копиро-
вание
Издание
Проект A
Проект B
233
Комплектование
производственной
бригады
не
вызывает
проблем,
однако
найти
редакторов
очень
нелегко.
Трудно
(или
невозможно)
заставить
переквалифицироваться
программиста
на
редактора,
еще
труднее
филолога
обучить
писать
материалы
по
программному
изделию.
Высокая
стоимость
подготовки
ру-
кописей
по
программному
изделию
заставляет
руководителей
давать
преимущества
производственного
роста
именно
редак-
торам,
тем
самым
привлекая
программистов
к
этой
работе.
8.5.2 Стандарты и практические руководства
Если
не
установить
правила
оформления
документации,
редакторы,
художники
и
т.п.,
подобно
программистам,
будут
действовать
в
зависимости
от
своих
вкусов
и
наклонностей.
Чтобы
продукция
имела
профессиональный
вид,
следует
начать
с
подбора
соответствующих
стандартов.
Одним
из
важнейших
стандартов
является
руководство
по
стилю.
В
нем
устанавливаются
виды
документации
и
даются
основные
рекомендации
по
оформлению:
размер
страницы,
шрифт,
стиль
художественного
оформления,
требования
к
сло-
варю
терминов,
порядок
индексирования,
способ
нумерации
разделов
и
отыскания
нужных
сведений,
формат
печати
и
др.
Выделяются
следующие
основные
виды
документации:
•
Техническое
описание
системы.
Это
введение,
изла-
гающее
основные
концепции
программного
изделия.
Оно
дает
будущему
пользователю
сведения
о
принци-
пах
функционирования
и
возможностях
программного
изделия,
характеризует
программное
изделие
в
терми-
нах
наиболее
общих
его
функций
и
освещает
самые
существенные
свойства.
Изложение
должно
быть
чет-
ким
и
касаться
наиболее
важных
характеристик
систе-
мы.
Это
описание
предназначено
для
лиц,
которые
мо-
гут
быть
не
знакомы
с
программированием
и
принци-
пами
работы
ЭВМ,
но
которые
определяют
выбор
и
приобретение
средств
вычислительной
техники.
Ос-
новным
первоисточником
для
технического
описания
должно
быть
соглашение
о
требованиях,
дополненное
материалами
групп
разработки
и
поддержки.
234
•
Справочное
руководство.
В
нем
подробно
описаны
все
внешние
характеристики
программного
изделия.
Оно
обеспечивает
пользователю
набор
информации
о
на-
значении
программного
изделия,
о
необходимом
обо-
рудовании
и
его
конфигурации,
о
языках
программи-
рования,
включая
форматы
команд
и
сообщений,
о
структурах
входных
и
выходных
данных,
о
взаимосвя-
зях
с
другими
программными
изделиями.
При
этом
предполагается,
что
читатель
справочного
руководства
имеет
опыт
работы
с
программами
и
техническими
средствами
ЭВМ.
Справочное
руководство
составляет-
ся
на
основе
внешних
спецификаций.
Дополнительный
материал
поставляет
группа
разработки.
Это
руково-
дство
предназначено
для
программистов
и
системных
аналитиков,
которые
являются
непосредственными
пользователями
программного
изделия.
•
Справочный
буклет.
Он
обычно
имеет
карманный
фор-
мат
и
содержит
краткие
сведения
из
справочного
руко-
водства.
Он
позволяет
быстро
ознакомиться
с
форма-
тами
операторов,
мнемоникой
операций,
таблицами
преобразования
кодов,
синтаксисом
языка.
В
наиболее
сжатой
форме
этот
документ
называют
справочным
формуляром.
•
Руководство
оператора
содержит
информацию
для
пользователей,
которая
указывает,
как
эксплуатировать
программу
и
соответствующее
оборудование.
Оно
описывает
требуемые
характеристики
технических
средств,
управляющие
сообщения
и
рабочие
процеду-
ры.
В
характеристиках
оборудования
излагаются
све-
дения
о
минимально
необходимой
конфигурации,
спе-
циальных
возможностях
оборудования
и
способах
за-
крепления
аппаратных
ресурсов
за
программами.
В
описании
управляющих
сообщений
даются
их
форма-
ты
и
правила
использования,
а
также
конкретные
при-
меры.
В
рабочих
процедурах
описываются
все
после-
довательные
этапы
управления
системой,
включая
на-
чальную
загрузку,
выполнение
заданий
и
восстановле-
235
ние
после
отказов.
Основным
источником
для
написа-
ния
руководства
оператора
служат
внешние
специфи-
кации.
Дополнительная
информация
поступает
от
группы
разработки
и
группы
испытаний.
Руководство
предназначено
для
операторов,
которые
могут
и
не
иметь
большого
опыта
работы.
•
Указатель
системных
сообщений.
В
этом
документе
описываются
все
сообщения,
порождаемые
програм-
мой,
а
также
ситуации,
в
которых
они
возникают,
и
необходимые
действия
оператора.
Указатель
составля-
ется,
в
основном,
по
листингам
программ
и
предназна-
чен
для
операторов,
программистов
и
системных
ана-
литиков.
В
интерактивном
режиме
появляется
возможность
опера-
тивно
выводить
справочную
информацию
на
экран.
В
таких
системах
выдается
большое
количество
сообщений
—
подска-
зок
и
сообщений
об
ошибках.
Группа
разработки
проектирует
лишь
программный
механизм
подобного
взаимодействия,
от-
ветственность
за
окончательную
реализацию
текстов
сообще-
ний,
их
стиль
и
форматы
несет
группа
выпуска
документации.
Она
приводит
и
проверяет
соответствие
печатных
материалов
сообщениям,
выдаваемым
в
режиме
on-line.
Кроме
соблюдения
стиля
документов,
группа
выпуска
до-
кументации
определят
поток
работ,
начиная
от
планирования
и
кончая
распространением
программного
изделия.
В
этой
инст-
рукции
описываются
методы,
позволяющие
планировать
про-
цесс
выпуска
документации
и
контролировать
выполнение
ка-
лендарного
плана.
8.5.3 Организация выпуска документации в фазах
исследований и анализа осуществимости
Группа
выпуска
документации
начинает
участвовать
в
работе
над
программным
изделием
в
рамках
фазового
обзора
I,
выполняя
предварительную
оценку
стоимости
издания
доку-
ментации.
Для
этого
приходится
принимать
некоторые
предпо-
ложения
относительно
вида
документации,
времени
издания
и
расценок.
Чем
определенней
составлены
стандарты
оформления