ВУЗ:
Составители:
Рубрика:
128
большей мере должна удовлетворять установленным требованиям к форме и
содержанию. Рассмотрим более подробно виды внешней документации.
Требования к системе оформляются в виде технического задания (см.
подразд.3.3), которое составляется обычно разработчиком совместно с заказ-
чиком, согласовывается, утверждается и является официальным документом,
на основании которого заключается контракт и ведутся работы по реализа
-
ции проекта.
Проектная документация включает в себя обширный набор документов
различного уровня и назначения, которые отражают развернутый план про-
екта. Отвечает за эту документацию главный конструктор проекта (систем-
ный аналитик). Для ее составления используется информация от программи-
стов (рабочая документация) и от пользователей (заказчиков). Обычно про-
ектная документация разделяется на
– проект системы, куда входят описание техпредложения (аванпроекта) и
различные документы, излагающие технические аспекты всей системы в
целом;
–
описание структуры данных, содержащее описание всех используемых в
программе данных (входных, выходных, внутренних, промежуточных),
представленных в виде файлов, таблиц, массивов и т.п.;
–
описание функциональной структуры программы, куда входят описания
алгоритмов, операций, программных модулей, таблиц вызовов и т.п.
Справочные пособия и руководства включают в себя всю документацию,
необходимую для использования программы. Обычно эта документация го-
товится специалистами по технической документации, которые берут для
этого исходную информацию у главного конструктора проекта и у програм
-
мистов-разработчиков. Сюда традиционно входят следующие виды докумен-
тов:
–
руководство пользователя, которое предназначено непосредственно для
пользователя и должно содержать (в доступной форме) общее описание
системы, подробные сведения о применении, разъяснение сообщений об
ошибках и других особых ситуациях;
–
руководство по обслуживанию, которое рассчитано на квалифицированно-
го инженера и содержит сведения, необходимые для глубокого понимания
работы системы, может содержать фрагменты проектной документации, а
также содержит описание всех деталей настройки и конфигурирования;
–
руководство оператора содержит четкие инструкции по установке, запуску
и правильной эксплуатации системы, рассчитано на технический персонал
не очень высокой квалификации.
Документация по ходу разработки отражает текущие результаты дея-
тельности группы разработчиков. Эта документация составляется на основе
текущей рабочей документации, но с учетом более жестких требований к
Страницы
- « первая
- ‹ предыдущая
- …
- 126
- 127
- 128
- 129
- 130
- …
- следующая ›
- последняя »