Для проекта необходимо наличие двух типов документации: для разработчиков и для пользователей.
Документация для разработчиков содержит в себе описание системы с точки зрения участника проекта. В данном случае отчет по курсовой работе – и является документацией для разработчика.
Документация для пользователей составляется следующим образом:
Описание системы (для чего она нужна, что позволяет делать)
Системные требования (требования к оборудованию и операционной системе)
Руководство по установке системы (как, используя дистрибутив, установить систему на компьютер)
Руководство пользователя (необходимо привести пошаговое описание работы с системой для каждого варианта использования)
Оформление финальной версии
При оформлении дистрибутива информационной системы необходимо наличие:
a. Электронная версия отчета (формат *.doc)
b. Исходный код программы (файлы проекта)
c. Текстовый файл с SQL-запросами на создание таблиц Вашей базы данных
d. Файл readme.txt с описанием процедуры установки разработанной системы.
e. Бумажный отчет
Файлы проекта, электронную версию отчета, SQL-запросы необходимо записать на компакт-диск CD-R и приложить к отчету.
Список литературы
1. Информационные системы / Петров В.Н. – СПб.: Питер, 2003. – 688 с.
2. Колисниченко Д.Н. Самоучитель PHP 5. - СПб.: Наука и техника. 2004. – 576 с.
3. Вигерс К. Разработка требований к программному обеспечению / Пер. с англ. – М.: Издательско-торговый дом «Русская редакция», 2004. – 576 с.: ил.
4. Грубер М. Понимание SQL. – Москва, 1993 – 290 с.
5. Документация по языку HTML. http://www.w3.org/TR/1998/REC-html40-19980424