4.3 Описание интерфейса задачи

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

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

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

Смена окон интерфейса должна соответствовать основной технологии решения задачи, начиная с настройки проекта (если она есть), формирования БД с помо-щью электронных документов, и реализации запросов к ней.

4.4 Описание программного обеспечения

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

Далее в порядке следования перечня по каждому из модулей приводится краткое описание алгоритма решения в текстовом виде. То есть какая входная информа-ция обрабатывается этим модулем, как она обрабатывается (извлекается ли для хранения, сортируется, вычисляется и т.п.) и какую выходную информацию дан-ный модуль создаёт – файлы, БД, документы, отчеты, формы и т.п. Если часть про-граммных моделей разработана “вручную” (ручное проектирование ПО), она должна иметь блок-схему алгоритма. Заголовок схемы должен содержать иденти-фикатор программы и через тире название программы. Если в тексте есть ссылки на данную схему, внизу должен стоять номер рисунка с названием схемы.

Последовательность описаний модулей по подпунктам данного раздела (блок-схема, текстовое описание) должна соответствовать этому перечню.

Блок-схемы имеют только модули запросов БД. Блок-схема, и описание должны иметь ссылку на идентификатор и наименование программного модуля.

4.5 Технологическая схема взаимосвязи программных модулей

Если технология проекта содержит небольшое число модулей, они могут быть приведены в разделе в виде схемы. При этом необходимо кратко описать после-довательность запуска каждого из них, показав тем самым, их соподчинённость друг другу.

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

Ниже представлен пример описания технологической схемы.

Рис 4.2 Взаимосвязь программных модулей задачи