Найти тему
все об айти22

Как правильно составлять Руководство системному программисту

1 ОБЩИЕ СВЕДЕНИЯ О ПРОГРАММЕ

1.1 Назначение программы

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

1.2 Функции программы  

Функции программы включают: 

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

− классификация заявок: система предоставляет возможность категоризировать заявки в соответствии с типами оборудования, приоритетом ремонта и другими параметрами.

− назначение исполнителя: программное обеспечение автоматически выбирает исполнителя на основе доступности, специализации и загруженности сотрудников, что позволяет оптимизировать процесс назначения и распределения работ.

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

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

1.3 Минимальный состав технических средств

Программа разработана на базе клиент-серверной архитектуры, где клиент представлен пользовательским интерфейсом, а сервер - базой данных.

Технические средства:

− Персональные компьютеры с необходимыми характеристиками для работы с программой.

− Серверное оборудование для установки серверной платформы и базы данных.

− Сетевое оборудование для обеспечения связи между клиентами и сервером.

 

1.4 Минимальный состав программных средств

Программные средства:

− Операционные системы, поддерживающие работу с программой.

− Клиентское программное обеспечение для запуска пользовательского интерфейса.

− Серверное программное обеспечение для установки серверной платформы и базы данных.

Также программная система использует язык программирования С# для реализации логики работы программы, а также использует СУБД SQLServer Managment для хранения и управления данными.

2 СТРУКТУРА ПРОГРАММЫ

2.1 Сведения о структуре программы

Программа структурно состоит из:

− пользовательского интерфейса;

− модуля обработки данных;

− модуля управления процессом ремонта;

− базы данных.

2.2 Сведения о составных частях программы

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

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

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

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

 

2.3 Сведения о связях между составными частями программы

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

 

2.4 Сведения о связях с другими программами

Связь специального ПО для автоматического учёта заявок на ремонт оборудования с другим программным обеспечением отсутствует. 

3 НАСТРОЙКА ПРОГРАММЫ

3.1. Настройка на состав технических средств

Специальное ПО для автоматического учёта заявок на ремонт оборудования не требует каких-либо настроек на состав технических средств.

 

3.2. Настройка на состав программных средств

Специальное ПО для автоматического учёта заявок на ремонт оборудования не требует каких-либо настроек на состав программных средств.

4 ПРОВЕРКА ПРОГРАММЫ

4.1 Контрольные примеры

Контрольные примеры:

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

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

− Редактирование существующей заявки. Проверка, что изменения сохраняются и отображаются корректно.

− Удаление заявки из базы данных. Проверка, что заявка успешно удалена и больше не отображается.

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

4.2 Методы прогона

Тестирование функциональности: выполнение контрольных примеров и проверка соответствия ожидаемых результатов фактическим.

Тестирование нагрузки: создание большого количества заявок одновременно для проверки стабильности и производительности программы.

Тестирование безопасности: проверка на возможность несанкционированного доступа к данным или изменения заявок.

4.3 Результаты

В случае успешного прохождения контрольных примеров и всех остальных тестов, можно сделать вывод о работоспособности программы и ее соответствии требованиям

Если выявлены ошибки или неполадки, необходимо подробно описать каждую проблему и ее влияние на функциональность программы.

При возникновении ошибок требуется провести дополнительные тесты или изменения в программе для их устранения.

5 ДОПОЛНИТЕЛЬНЫЕ ВОЗМОЖНОСТИ

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

6 СООБЩЕНИЯ СИСТЕМНОМУ ПРОГРАММИСТУ

Сообщение: «Ошибка настройки базы данных. Проверьте параметры подключения». Описание: данное сообщение указывает на проблемы с настройкой базы данных. Система не может подключиться к базе данных из-за неверных параметров подключения. Действия: проверьте правильность заданных параметров подключения к базе данных. Убедитесь, что указаны правильный адрес сервера, порт, имя пользователя и пароль. Если все параметры верны, проверьте доступность сервера базы данных.

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

Сообщение: «Ошибка доступа к файлу. Проверьте разрешения доступа». Описание: это сообщение указывает на проблемы с доступом к файлу, необходимому для выполнения определенной операции. Возможно, у пользователя нет достаточных прав на чтение, запись или выполнение определенного файла. Действия: проверьте разрешения доступа к файлам и папкам, используемым программой. Убедитесь, что пользователь имеет достаточные права на работу с этими файлами. Если ошибка сохраняется, обратитесь к системному администратору или к разработчику программы.

Сообщение: «ошибка подключения к серверу. Проверьте сетевое соединение». Описание: Данное сообщение указывает на проблемы с подключением к удаленному серверу. Программа не может установить соединение из-за проблем в сети или неправильных настройках подключения. Действия: проверьте сетевое соединение и убедитесь, что сервер доступен. Проверьте настройки подключения к серверу и убедитесь, что они правильные. Если проблема не устраняется, обратитесь к сетевому администратору или к разработчику программы.

Сообщение: «Ошибка сохранения данных. Проверьте доступность базы данных». Описание: это сообщение указывает на проблемы с сохранением данных в базу данных. Возможно, база данных недоступна или возникли ошибки при выполнении операции записи. Действия: проверьте доступность сервера базы данных и убедитесь, что база данных работает корректно. Если ошибка сохраняется, обратитесь к сетевому администратору или к разработчику программы для проверки настроек базы данных.