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

1. Руководство системного программиста

Руководство администратора было написано в соответствии с ГОСТ 19.503-79 Руководство системного программиста.

1. Общие сведения о информационной системе

Информационная система «ШМП» предназначена для автоматизации деятельности обучения молодых предпринимателей. Главной функцией информационной системы является, просмотр видеоуроков, создание видеоуроков, сдача теста. Также в программе присутствуют три типа учетных записей: слушатель, администратор и эксперт.

Требования к аппаратному обеспечению:

1. Intel Pentium III 800 MHz.

2. 32 MB RAM (128 Mb рекомендовано).

3. свободное место на HDD от 2048 Мб и более для самой программы и хранимых данных.

Периферийные устройства:

1. мышь.

2. клавиатура.

Требуемое программное обеспечение:

1. операционная система: Microsoft Windows XP/2000/Vista/7, FreeBSD(рекомендовано).

1. СУБД: MySQL Server.

2. Web-server: Apache.

3. интерпретатор php 5.3.6.

2. Структура информационной системы

Программа состоит из 46 php-файлов не считая подключаемых скриптов и библиотек. Главный файл проекта называется index.php, все файлы программы делятся на:

1. Видимые php - файлы – файлы содержащие в себе большую часть кода программы, ниже приведен список данных файлов:

- readport.php – отвечает за отображение данных портфолио;

- reg.php – отвечает за форму регистрации;

- send.php – отвечает за отправку сообщения;

- teachers.php – отвечает за форму с преподавателями;

- Testts.php – отвечает за отображение теста по уроку;

- upload.php – отвечает за загрузку файла на сервер;

- upload1.php – отвечает за загрузку файла на сервер;

- users.php – отвечает за отображение списка пользователей;

- Video.php – отвечает за отображение видеоурока;

- videouroki.php – отвечает за отображение списка видеоуроков;

- addmes.php – отвечает за добавление сообщения;

- addnews.php – отвечает за добавление новости;

- allnews.php – отвечает за отображение всех новостей ;

- button1.php – отвечает за отображение кнопки;

- button2.php – отвечает за отображение кнопки;

- createtest.php – отвечает за создание тестового задания;

- crport.php – отвечает за создание портфолио;

- crport2.php – отвечает за создание портфолио;

- crport3.php – отвечает за создание портфолио;

- exit.php – отвечает за выход и удаление cookie;

- forum.php – отвечает за отображение списка тем в форуме;

- index.php – файл главной страницы;

- inputmessage.php – отвечает за чтение входящего сообщения;

- jq.php – отвечает за общее подключение библиотеки jQuery;

- log.php – отвечает за авторизацию;

- mainforum.php - отвечает за отображение сообщений в теме форума;

- newnews.php – отвечает за отображение архива новостей;

- news.php – отвечает за отображение новости;

- portfolio.php – отвечает за отображение портфолио;

- proekt.php – отвечает за отображение информации «о проекте»;

- prof.php – отвечает за отображение личного кабинета;

- reshtest.php – отвечает за отображение полей ввода результатов теста;

- read.php – отвечает за отображение входящего сообщения.

2. Визуально не отображаемые php-файлы – файлы содержащие в себе большую часть кода программы, однако обращение к ним производится через видимые php-файлы, ниже приведен список данных файлов:

- prof_update.php – отвечает за изменение информации в личном кабинете;

- output.php – отвечает за отправку сообщения на форум;

- output2.php – отвечает за отправку личного сообщения;

- reg2.php – отвечает за запись данных при регистрации;

- CrTest.php – отвечает за запись данных при создании теста;

- crtheme.php – отвечает за создание темы на форуме;

- CrVidur.php – отвечает за запись видеоурока;

- rast.php – отвечает за расчет теста;

- rast2.php - отвечает за запись расчета теста;

- Createv.php – отвечает за создание видеоурока.

3) Библиотеки – подключаемые модули, состоящие из js-файлов, отличающиеся от java – скриптов расширенными фунциональными возможностями, ниже приведен список данных файлов:

- jquery.js – библиотека.

4) Подключаемы java – скрипты – подключаемые модули, состоящие из js-файлов, ниже приведен список данных файлов:

- scripts.js прочие скрипты;

- jquery.messageWindow.js – скрипт отвечающий за отображение валидности ввода данных;

- jquery.validationEngine.js js – скрипт отвечающий за отображение валидности ввода данных.

5) Подключаемые php - скрипты ­­– php-файлы подключаемые к видимым php-файлам, предназначены для разгрузки кода, ниже приведен список данных файлов:

- head.php – головное меню;

- headmenu.php – кнопочное головное меню;

- menu.php – кнопочное левое меню.

Все скрипты связаны между собой, а также с БД, структура модулей приведена ниже (рис 5.1).

Рисунок 5.1 – Модульная схема программы