ДОКУМЕНТИРОВАНИЕ ПРОЕКТА

12. ДОКУМЕНТИРОВАНИЕ ПРОЕКТА

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

12.1. ПАСПОРТ ПРОЕКТА

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

"Паспорт проекта" поддерживается руководителем проекта. "Паспорт проекта" определяет такие ключевые для проекта вопросы как:

среда исполнения проекта – аппаратные требования, требования к ОС, требования к сетевой среде, требования к СУБД и другим внешним по отношению системам, с которым должны взаимодействовать полученные в результате реализации проекта приложения;
среда разработки проекта – используемые средства автоматизированного проектирования, используемые языки программирования, компиляторы и трансляторы языков, IDE-среда программирования, средства для проектирования БД, в том числе визуальные построители запросов и дизайнеры БД, используемые компоненты, не входящие в стандартную поставку используемой среды программирования;
средства создания документации – используемые инструменты для генерации документации, входящие в конечную поставку приложения;
средства создания дистрибутива – используемая среда для генерации дистрибутива, поставляемого конечному пользователю созданных в результате реализации проекта приложений;
среда для тестирования проекта – описывается среда, а также инструментальные средства, применяемые для тестирование проекта.

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

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

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

"Паспорт проекта" является исходной точкой для управления процессом внедрения инноваций в процессе работы над проектом – любые изменения, касающиеся ключевых вопросов разработки отражаются в данном документе и должны быть приняты всеми участниками проекта во внимание.

В случае, если работа над проектом приостанавливается или откладывается на продолжительный срок, использование документа "Паспорт проекта" позволяет при необходимости воссоздать актуальную среду разработки при возвращении к работам над проектом.

Учитывая возможность работы одних и тех же разработчиков над различными проектами, в процессе которой они могут использовать различную среду разработки, в том числе и взаимоисключающую, документ "Паспорт проекта" позволяет им воссоздать актуальную среду разработки для работы над каждым конкретным проектом.

Также "Паспорт проекта" может быть использован разработчиком при начальной подготовке своего рабочего места к работе над конкретным проектом.

В Приложении А представлен образец документа "Паспорт проекта".

СОДЕРЖАНИЕ