Виды программной документации

ДОКУМЕНТИРОВАНИЕ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ, ЕСПД

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

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

Виды программ и программных документов для ЭВМ комплексов и систем независимо от их назначения и области применения установлены ГОСТ 19.101-77 и ГОСТ 19781-90.

Гостированные определения.

ПРОГРАММА – это данные, предназначенные для управления конкретными компонентами системы обработки информации в целях реализации определенного алгоритма

Программы подразделяют на два вида: компонент и комплекс.

КОМПОНЕНТ - программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса.

КОМПЛЕКС - программа, состоящая из двух или более компонент и

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

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ - совокупность программ системы обработки информации и программных документов, необходимых для эксплуатации этих программ.

К программным документам относят документы, содержащие сведения, необходимые для:

1) разработки;

2) изготовления;

3) сопровождения;

4) эксплуатации программ.

Виды ПД и их содержание, правила оформления документов и их частей устанавливаются соответствующими стандартами ЕСПД.

Для МАЛЫХ АВТОНОМНЫХ программ в качестве документации используется в основном текст оттранслированной программы на языке программирования. Сопровождение таких программ не их разработчиками практически невозможно.

Для БОЛЬШИХ ПРОЕКТОВ программ необходима полная документация.

Для чего нужна документация?

Документация на ПС решает следующие задачи:

1) формализует методы решения задач, состав используемой и выдаваемой информации;

2) способствует резкому сокращению количества ошибок и тем самым облегчает отладку;

3) позволяет вносить и учитывать изменения в программах;

4) обеспечивает возможность замены первичного разработчика программы другим без повторения ранее выполненной работы;

5) позволяет изучать, эксплуатировать и модернизировать ПО;

6) позволяет использовать разработанные компоненты и комплексы

программ в разных ПС и применять сборочное программирование.

Документацию не очень хочется писать. Но без документации кроме всего прочего:

1) можно занести вирус;

2) режимы работы исследуются вслепую методом проб и ошибок;

3) неизвестно что делать в непредвиденных случаях.

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

Виды программной документации:

- эксплуатационная;

- технологическая;

- исследовательская.

ЭКСПЛУАТАЦИОННАЯ (пользовательская) документация - это минимально необходимые сведения для эксплуатации ПО.

К такой документации относятся документы, которыми руководствуется пользователь при:

- инсталяции ПС (при установке ПС с соответствующей настройкой на среду применения ПС);

- при применении ПС для решения своих задач и при управлении ПС (например, когда данное ПС взаимодействует с другими системами).

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

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

ТЕХНОЛОГИЧЕСКАЯ документация кроме эксплуатационной документации включает ряд документов, необходимых для развития и сопровождения ПО в течение всего жизненного цикла.

ИССЛЕДОВАТЕЛЬСКАЯ документация предназначена для анализа жизненного цикла ПО. Основная ее задача состоит в фиксировании и обобщении характеристик жизненного цикла ПО.

Жизненные случаи:

1) программма работает, но ни кто не знает как она это делает

2)