English version

Профессиональный PHP-программист:

создание сайтов, движков, аудит и оптимизация сайтов
Пишите!
ICQ
176621941

Образцы документации

Web-проект это не просто написанный скрипт или сверстанная страница, это еще и прилагаемая к проекту входная и выходная документация*.

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

Кроме того, в случае сложного проекта может составляться Структура сайта и другие дополнительные документы. ТЗ является формальным документом, описывающим проект в целом, права и обязанности исполнителя и заказчика, определяющим сроки выполнения проекта и гарантии. В Структуре сайта детально описываются механизмы проекта, содержимое всех страниц и т.п.

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

От качества составления входной документации зависит степень согласованности самих работ и в конечном итоге быстрота и качество выполнения проекта. Корректная выходная документация - значительное облегчение труда редакторов и программистов, которым предстоит работать над проектом в дальнейшем. Вот некоторые образцы документов:

* - входная документация составляется в обязательном порядке и бесплатно. Выходная документация может составляться за отдельную плату, что оговаривается в ТЗ.