Оформление программной документации

Разработка программной документации в соответствии с Единой системой программной документации для сдачи гос. заказчику при выполнении НИОКР и разработка эксплуатационной и технической документации для дальнейшего распространения, сопровождения и развития программных изделий.

Документирование UML

В общем случае программную документацию можно разделить на два типа - программные и эксплуатационные документы. Термины позаимствованы из серии ГОСТов под названием "Единая система программной документации" или сокращённо ЕСПД.

Программные документы

Программные документы описывают техническую организацию программы или комлекса программ, содержат, например, такие вещи как использованные языки прораммирования и технологии, назначение отдельных программных модулей и связи между ними, программный код и комментариии к нему. Данный тип документации необходим для дальнейшей модификации программного изделия - при расширении функционала, исправлении ошибок, интеграции с другими программами и системами и т.д. Качественно разработанная программная документация позволит сопровождать и развивать программное изделие любым прораммистам, владеющим необходимыми технолоиями. Отсутствие же технической документации делает невозможным сопровождение продукта кем-либо, кроме непосредственного разработчика. Мы рекомендуем при приёмке программного обеспечения убедиться в наличии в программных документах следующих сведений:

- полное описание среды разработки и зависимостей;

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

- диаграмма размещения, описывающая размещение программных модулей на аппаратных средствах;

- исходный код программного обеспечения с комментариями в формате Doxygen;

- пошаговая инструкция по сборке.

Эксплуатационная документация

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