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

Любая программа должна снабжаться программной документацией.

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

1) изготовления (разработки)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2)

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

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

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

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

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

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

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

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

Документация, создаваемая в процессе разработки программ, необходима

как средство:

- передачи информации между разработчиками ПС,

- управления разработкой ПС

- передачи пользователям информации, необходимой для применения и сопровождения ПС.

На создание этой документации приходится большая доля стоимости ПС.

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

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

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

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

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

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

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

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

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

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

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

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