Преглед изворни кода

Добавлено OperatorGuide.md

Firioo пре 1 недеља
родитељ
комит
ed1fc95aea
1 измењених фајлова са 211 додато и 0 уклоњено
  1. 211 0
      OperatorGuide.md

+ 211 - 0
OperatorGuide.md

@@ -0,0 +1,211 @@
+# Руководство оператора программы «Учёт компьютерного оборудования»
+
+## Аннотация
+
+Настоящий документ содержит информацию, необходимую для работы с программой «Учёт компьютерного оборудования». Программа предназначена для ведения партионного учёта компьютерной техники: регистрации закупок, списаний и контроля текущих остатков на складе. Документ адресован конечным пользователям системы – сотрудникам отдела снабжения, кладовщикам и системным администраторам.
+
+## Введение
+
+### Область применения
+
+Программа предназначена для использования на предприятиях и в организациях, где ведётся учёт компьютерного оборудования. Система позволяет:
+
+- вести учёт оборудования по типам (моделям) с партионным методом;
+- регистрировать поступление (закупки) и выбытие (списания) оборудования;
+- получать актуальную информацию об остатках на складе.
+
+Программа работает с удалённой базой данных PostgreSQL, что позволяет нескольким пользователям одновременно работать с единой информационной системой.
+
+### Основные возможности
+
+- Отображение текущих остатков оборудования с автоматическим расчётом количества на складе.
+- Ведение журнала закупок с указанием поставщика, склада, количества, цены и даты.
+- Ведение журнала списаний с указанием ответственного сотрудника, причины и даты.
+- Добавление, редактирование и удаление записей о закупках и списаниях.
+- Поиск по названию оборудования, производителю, поставщику или фамилии сотрудника.
+- Экспорт любой таблицы в CSV-файл для формирования отчётов.
+- Логирование всех изменений для аудита.
+
+## Подготовка к работе
+
+### Порядок установки
+
+Для работы с программой не требуется сложной установки. Достаточно выполнить следующие шаги:
+
+1. Скачайте исполняемый файл `programm.exe` из репозитория или из папки `dist` архива с программой.
+2. Сохраните файл в любую папку на вашем компьютере (например, на рабочий стол или в папку «Программы»).
+3. Убедитесь, что ваш компьютер имеет доступ к интернету – программа подключается к удалённому серверу базы данных.
+4. Запустите файл двойным щелчком левой кнопки мыши.
+
+**Примечание:** Если антивирус блокирует запуск, добавьте файл в исключения – программа безопасна и не содержит вредоносного кода.
+
+Для администратора: Если база данных ещё не создана или требуется развернуть систему на новом сервере, выполните следующие шаги. Вся структура БД описана в файле init_db.sql, который поставляется вместе с программой.
+
+### Порядок проверки работоспособности
+
+Для проверки правильности установки и настройки выполните следующие тесты:
+
+1. **Тест 1. Запуск программы.**  
+   Запустите `programm.exe`. Должно открыться главное окно с тремя вкладками. Если окно не появилось – проверьте, что у вас установлен .NET Framework или обратитесь к системному администратору.
+
+2. **Тест 2. Загрузка данных.**  
+   На вкладке «Остатки оборудования» должна отобразиться таблица с перечнем оборудования. Если таблица пуста – проверьте подключение к интернету.
+
+3. **Тест 3. Добавление записи.**  
+   Перейдите на вкладку «Закупки», нажмите кнопку «Добавить закупку», заполните любые поля и сохраните. Если запись появилась в таблице – программа работает корректно.
+
+4. **Тест 4. Обновление остатков.**  
+   После добавления закупки перейдите на вкладку «Остатки оборудования» и нажмите «Обновить». Количество выбранного оборудования должно увеличиться.
+
+5. **Тест 5. Экспорт.**  
+   На любой вкладке нажмите «Экспорт CSV». В папке с программой должен появиться файл с именем, содержащим дату и время.
+
+Если все тесты пройдены успешно, программа готова к использованию.
+
+## Описание операций
+
+### Главное окно программы
+
+Главное окно содержит три вкладки, между которыми можно переключаться. В верхней части окна находится панель поиска, в нижней – таблица с данными, а также кнопки управления.
+
+| Вкладка | Назначение |
+|---------|------------|
+| Остатки оборудования | Показывает список типов оборудования с текущим количеством на складе. Обновляется автоматически после изменения закупок или списаний. |
+| Закупки | Предназначена для учёта поступлений. Содержит журнал всех закупок с детальной информацией. |
+| Списания | Предназначена для учёта выбытия. Содержит журнал списаний с указанием причин. |
+
+### Поиск информации
+
+Для поиска данных:
+
+1. Введите ключевое слово в поле поиска на нужной вкладке.
+2. Нажмите кнопку «Найти».
+3. Таблица отфильтруется, отображая только те записи, в которых название оборудования, производитель, поставщик или фамилия сотрудника начинаются с введённого текста.
+4. Чтобы снять фильтр, нажмите кнопку «Сброс».
+
+**Примечание:** Поиск выполняется по началу строки. Например, чтобы найти ноутбуки Lenovo, введите «Lenovo».
+
+### Добавление записи
+
+#### Добавление закупки
+
+1. Перейдите на вкладку «Закупки».
+2. Нажмите кнопку «Добавить закупку».
+3. В открывшейся форме заполните все поля:
+   - **Оборудование** – выберите из выпадающего списка.
+   - **Поставщик** – выберите из списка.
+   - **Склад** – выберите склад, на который поступило оборудование.
+   - **Количество** – укажите целое число больше нуля.
+   - **Цена за единицу** – укажите цену в рублях (можно с копейками).
+   - **Дата закупки** – введите в формате ГГГГ-ММ-ДД.
+   - **Примечание** – необязательное поле для комментариев.
+4. Нажмите «Сохранить».
+
+#### Добавление списания
+
+1. Перейдите на вкладку «Списания».
+2. Нажмите кнопку «Добавить списание».
+3. В открывшейся форме заполните:
+   - **Оборудование** – выберите из списка.
+   - **Сотрудник** – ответственный за списание.
+   - **Количество** – укажите количество списываемых единиц.
+   - **Причина списания** – укажите причину (например, «Поломка», «Утилизация»).
+   - **Дата списания** – в формате ГГГГ-ММ-ДД.
+4. Нажмите «Сохранить».
+
+### Редактирование записи
+
+1. Выберите строку в таблице, щёлкнув по ней мышью (строка подсветится).
+2. Нажмите кнопку «Редактировать».
+3. В появившемся окне измените нужные поля.
+4. Нажмите «Сохранить» для применения изменений.
+
+**Важно:** Редактирование доступно только для записей в журналах закупок и списаний. На вкладке «Остатки» редактирование невозможно – остатки вычисляются автоматически.
+
+### Удаление записи
+
+1. Выберите строку в таблице.
+2. Нажмите кнопку «Удалить».
+3. Подтвердите удаление в диалоговом окне.
+
+**Внимание:** Удаление записи о закупке или списании повлияет на расчёт остатков. Убедитесь в правильности действия перед подтверждением.
+
+### Экспорт данных в CSV
+
+1. Перейдите на нужную вкладку (Остатки, Закупки или Списания).
+2. Нажмите кнопку «Экспорт CSV».
+3. Файл будет сохранён в папке с программой с именем `stock_ГГГГММДД_ЧЧММСС.csv` (или `purchases_...`, `writeoffs_...`).
+4. Файл можно открыть в Microsoft Excel, LibreOffice Calc или любом текстовом редакторе.
+
+### Обновление данных
+
+Нажмите кнопку «Обновить» на любой вкладке, чтобы загрузить актуальные данные из базы. Обычно обновление происходит автоматически после операций добавления/редактирования/удаления, но в некоторых случаях (например, если другой пользователь изменил данные) может потребоваться ручное обновление.
+
+## Аварийные ситуации
+
+### Не удаётся подключиться к базе данных
+
+**Признак:** При запуске или обновлении появляется сообщение об ошибке подключения.
+
+**Действия:**
+1. Проверьте подключение к интернету.
+2. Подождите несколько минут и попробуйте снова – возможно, сервер временно недоступен.
+3. Если проблема повторяется, обратитесь к системному администратору – возможно, изменились параметры подключения.
+
+### Программа зависла или не реагирует
+
+**Признак:** Интерфейс не отвечает на нажатия кнопок или долго загружается.
+
+**Действия:**
+1. Закройте программу (используйте диспетчер задач, если необходимо).
+2. Запустите заново.
+3. Если проблема повторяется, попробуйте перезагрузить компьютер.
+4. Если ситуация не изменяется, свяжитесь с разработчиком (указаны в разделе «Автор»).
+
+### Ошибка при добавлении/редактировании записи
+
+**Признак:** При сохранении формы появляется сообщение «Проверьте введённые данные» или «Ошибка БД».
+
+**Действия:**
+1. Проверьте, что все обязательные поля заполнены.
+2. Убедитесь, что дата введена в формате ГГГГ-ММ-ДД.
+3. Проверьте, что количество – целое число, а цена – число (с точкой или запятой в качестве разделителя).
+4. Если вы используете запятую в цене, замените её на точку (например, `12500.50` вместо `12500,50`).
+5. Повторите попытку.
+
+### Антивирус блокирует запуск
+
+**Признак:** При запуске `programm.exe` антивирус сообщает о подозрительной активности и блокирует файл.
+
+**Действия:**
+1. Добавьте файл или папку с программой в исключения антивируса.
+2. Либо временно отключите антивирус на время работы (не рекомендуется на постоянной основе).
+3. Программа безопасна и не содержит вирусов – это ложное срабатывание из-за того, что исполняемый файл был собран с помощью PyInstaller.
+
+### Потеря данных
+
+**Признак:** При открытии программы таблицы пусты или данные отсутствуют.
+
+**Действия:**
+1. Убедитесь, что вы подключены к правильной базе данных (проверьте настройки у администратора).
+2. Нажмите кнопку «Обновить» – возможно, данные просто не загрузились.
+3. Если данные действительно потеряны, обратитесь к администратору базы данных для восстановления из резервной копии.
+
+## Термины и сокращения
+
+| Термин | Описание |
+|--------|----------|
+| БД | База данных, хранилище всей информации о оборудовании, закупках и списаниях. Используется PostgreSQL. |
+| Оборудование | Тип (модель) компьютерной техники, которая учитывается в системе (например, «Ноутбук Lenovo T14»). |
+| Закупка | Операция поступления партии оборудования от поставщика на склад. |
+| Списание | Операция выбытия партии оборудования (утилизация, продажа, передача другому подразделению). |
+| Остаток | Текущее количество оборудования на складе, вычисляемое как сумма закупок минус сумма списаний. |
+| CSV | Формат файла для экспорта данных (Comma-Separated Values). Открывается в Excel и других табличных редакторах. |
+| GUI | Графический интерфейс пользователя (Graphical User Interface). |
+| PostgreSQL | Система управления базами данных, используемая для хранения данных. |
+| СУБД | Система управления базами данных – программное обеспечение для управления БД. |
+
+---
+
+**Автор документации:** [Железков Фёдор]  
+**Дата:** 2026 г.