Разработка Технической документации на сайт

Глава 2. Разработка web-сайта на CMS Joomla.

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

В ней описаны основные требования к проекту в плане внешнего вида, функционала, сроков сдачи проекта, и является гарантией сдачи проекта в срок для заказчика, и обеспечение оплаты труда разработчика.

Одним из таких документов является техническое задание.

Определение этого термина следующее: техническое задание-это специальный документ, разработанный заказчиком и утвержденный исполнителем, в котором изложены требования, параметры и основные эксплуатационные характеристики проекта, объекта или системы. Среди прочего, этот документ может включать список требований к тестированию.

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

Рис 1

Описание программы.

Данный документ предоставляет подробное описание проекта, будь то сайт, или какая – либо программа. Данный документ оформляется в соответствии с ГОСТ 19.402-78, и содержит в себе следующие подразделы:

В подразделе "Общие сведения" необходимо указать: наименование и наименование программы; программное обеспечение, необходимое для работы программы; языки программирования, на которых написана программа.

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

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

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

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

"Входные данные" - должны быть указаны: характер, организация и предварительная подготовка входных данных, Формат, описание и способ кодирования входных данных.

"Выходные данные" - следует указать характер, организацию и предварительную подготовку выходных данных, Формат, описание и метод кодирования выходных данных.

Индивидуальные разделы можно совместить. Некоторые пункты этого раздела повторяют разделы технического проекта. Такие повторы предусмотрены ГОСТом, так как на стадии рабочего проекта происходят некоторые дополнения или изменения в составе технических средств или программы.

Описание применения программы.

В данном документе подробно описаны характеристики проекта, его предназначение, условия, необходимые для работы, и задачи, которые он выполняет. Оформляется в соответствии с ГОСТ 19-502-78, и должен содержать следующие подразделы:

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

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

В разделе "Описание задачи" должны быть указаны определения задачи и методы ее решения.

В разделе "Входные и выходные данные" должны быть указаны сведения о входных и выходных данных.

В приложение к общему описанию могут быть включены справочные материалы (иллюстрации, таблицы, графики, примеры и т.п.).

2.2 Разработка сайта спорткомплекса «Дельфин» в CMS Joomla .