Материал: Основы проектирования программ

Программа «Adobe RoboHelp»

Одним из популярных сред для создания и редактирования справочных систем (или систем помощи типа Help) является Adobe RoboHelp. Это мощнейшее средство для создания профессиональной системы справочной информации или технической документации (рис 6.).

Рис. 6. Рабочее место «Adobe RoboHelp»

Программа позволяет публиковать выходные документы в формате HTML5. При наличии компонента TCS2 (Tata Consultancy Services 2) RoboHelp появляется возможность формировать итоговые документы в большее количество форматов. Работа в данной системе ведется по тематическим разделам. В системе доступен многопользовательский режим и контроль версий. Возможен импорт в систему документов следующих форматов: FrameMaker, PDF, XML, DITA maps и DITA topics. В системе реализована поддержка форматов GIF, JPEG, BMP, MRB (Multi-Resolution Bitmap), WMF (Windows Metafile) и PNG при работе с изображениями. Есть возможность оставлять комментарии к тексту [https://softline.ru/about/news/4926, https://compress.ru/article.aspx?id=18799#Adobe%20RoboHelp%207].

Помимо вышеперечисленного, расширенный набор функций, интегрированный HTML-редактор и контроль над генерируемым HTML-кодом являются основными преимуществами данной системы. Ограничением системы является отсутствие возможности использовать стили, иконки, сниппеты в нескольких проектах. Также программа довольно большая по объёму – вес архива составляет примерно 800 МБ (мегабайт). Также нет возможности создавать документы непосредственно в Robohelp, они могут быть созданы, например, с помощью Microsoft Word, а затем загружаются в RoboHelp для дальнейшей работы с текстом. Цена составляет приблизительно 999 долларов.

Программа «Author-it»

Author-it публикует выходные документы в форматах Word Document, PDF, Windows Help, HTML Pages, HTML Help, XHTML Pages, Java Help и Oracle Help for Java. Имеется возможность подключения к собственной БД: SQL (Structured Query Language) Server или JET / SQL Server Express (бесплатная версия). Реализована блокировка документа в момент его редактирования каким-либо пользователем, что позволяет организовать работу всего коллектива, пользующегося данной системой. В системе доступен контроль версий. При редактировании документа пользователям, доступен только для чтения в последней сохранённой версии документа. Возможен импорт в систему документов следующих типов файлов: Word Document, RTF, FrameMaker, WinHelp, WinHelp Project, HTML Help, Robohelp и HTML. В системе реализована поддержка форматов BMP, GIF, JPG, PNG и WMF и при работе с изображениями. Есть возможность оставлять комментарии к тексту [http://authorit.ru].

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

Результаты сравнительного анализа широко распространенных приложений для формирования и написания технических заданий приведены в таблице 1.

Таблица 1

Сравнительный анализ приложений для формирования и написания технических заданий

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

Рассмотренные информационные системы «AdobeRoboHelp» и «Author-it» не доступны для бесплатного скачивания. Помимо уплаченной стоимости приобретения указанных программ, дополнительно потребуется осуществлять расходы на обслуживание и поддержку систем. Также системы не соответствует тем, что в них невозможно хранить историю документа, формировать отчеты о состоянии готовности технического задания, иные отчеты, связанные с создаваемым документом.

«Мастер технических заданий» доступна для приобретения, но она не является многопользовательской. Также система не позволяет осуществлять просмотр документа в онлайн-режиме, осуществлять работу в программе на операционной системе, отличной от WINDOWS.

Проектируемая же в рамках данной работы информационная система, основана на коде программного продукта фирмы 1С, так как их язык обладает наибольшим количеством положительных характеристик. Помимо всего система бесплатна в обслуживании, так как в организации присутствует свой штат программистов. В дальнейшем есть перспектива настройки интеграции для передачи согласованных документов.

1.6Формирование требований к разрабатываемой системе

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

В процессе проведения анализа также можно выделить ряд требований к разрабатываемой системе:

• Интерфейс системы должен быть максимально приближен к интерфейсам подобных систем;
• Возможность удаленного доступа;
• Возможность просмотра и скачивания готовых экземпляров документа;
• Освобождение разработчика документации от необходимости форматировать тексты;
• Автоматическое использование одного и того же текста в разных документах (или частях одного документа);
• Формирование документации в форматах DOCX (Microsoft Word Open XML Document), PDF, HTML (HyperText Markup Language) и RTF (Rich Text Format) без потери в качестве оформления текста;
• хранение истории изменений выходных документов;
• импорт документов в систему для наполнения базы теми документами, которые были созданы до внедрения системы;
• поддержка следующих форматов изображений при работе с документами: JPG (Joint Photographic Experts Group), PNG (Portable Network Graphics), BMP (Bitmap Picture) и TIFF (Tagged Image File Format) [https://www.intuit.ru/studies/courses/2195/55/lecture/15050?page=2].

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

• Отчет о состоянии готовности технического задания;
• Отчет об объектах автоматизации в рамках проекта;
• Отчет о составе проектных команд;
• Отчет о требованиях к системе и программному обеспечению;
• Отчет о действующих клиентах;
• Отчет по оплатам клиента и выставленным счетам.

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

Использование информационной системы предполагается следующими типами пользователей, каждый из которых имеет свои собственные потребности:

• Директор по проектам;
• Руководитель проекта;
• Менеджер по продажам;
• Администратор проекта;
• Специалист отдела консалтинга (консультант);
• Разработчик (программист);
• Системный администратор.

Директор по проектам / Архитектор должен иметь возможность:

• Заполнять шаблон «Требования к системе» (Требования к системе в целом, требования к видам обеспечения);
• Заполнять шаблон «Требования к составу и содержанию работ по подготовке объекта автоматизации к вводу системы в действие»;
• Просмотр технического задания;
• Формирование отчетов:
• о состоянии готовности технического задания;
• о собранной информации от функционального Заказчика;
• о текущих проблемах на проекте,
• об автоматизируемых бизнес-процессах в рамках проекта;
• об основных требованиях к системе;
• об основных требованиях к программному обеспечению;
• о функциональных требованиях.

Руководитель проекта должен иметь возможность:

• Заполнять шаблон «Цели и назначение системы»;
• Заполнять шаблон «Характеристики объекта автоматизации»;
• Заполнять шаблон «Состав и содержание работ»;
• Заполнять шаблон «Порядок контроля и приемки системы»;
• Заполнять шаблон «Требования к документированию»;
• Заполнять шаблон «Источники разработки»;
• Просмотр технического задания;
• Формирование отчетов:
• о состоянии готовности технического задания;
• о собранной информации от функционального Заказчика;
• о текущих проблемах на проекте,
• об автоматизируемых бизнес-процессах в рамках проекта;
• об основных требованиях к системе;
• об основных требованиях к программному обеспечению;
• о функциональных требованиях.

Менеджер по продажам должен иметь возможность:

• Заполнять шаблон «Общие сведения».

Администратор проекта должен иметь возможность:

• Просмотра технического задания;
• Рецензирования технического задания;
• Печати технического задания.

Консультант должен иметь возможность:

• Хранить собранную информацию от функционального Заказчика;
• Хранить нормативные документы, регламентирующие написание технических заданий;
• Хранить информацию об автоматизируемых бизнес-процессах в рамках проекта;
• Формирование отчетов:
• о собранной информации от функционального Заказчика;
• об автоматизируемых бизнес-процессах в рамках проекта;
• об основных требованиях к системе;
• об основных требованиях к программному обеспечению;
• о функциональных требованиях.

Разработчик должен иметь возможность:

• Просматривать все разделы технического задания.

Администратор системы должен иметь возможность:

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

Ролевая модель пользователей, взаимодействующих с информационной системой, определена в таблице 2.

Таблица 2

Ролевая модель

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

В таблице 3 сформулированы требования к разрабатываемой системе, предъявляемые ролевой моделью пользователей к проектируемой информационной системе, в зависимости от их потребностей с указанием цели наличия той или иной функции.