DocChecker – Интеллектуальный инструмент проверки документов
DocChecker – это автоматизированный инструмент для контроля качества технической документации, API-спецификаций и структурированных текстов. Он сочетает в себе проверку по формальным правилам и семантический анализ, что позволяет оперативно выявлять несогласованность терминов, ошибки форматирования, пропуски обязательных разделов и логические противоречия. Результаты проверки выводятся в удобном для визуального и автоматизированного просмотра виде.
---
Основные возможности
- Многогранная проверка
Поддерживается валидация формата, контроль единообразия терминологии, а также проверка наличия всех необходимых разделов документа.
- Семантический анализ
Встроенный модуль на Python (`semantic_analyzer.py`) выполняет углублённую обработку текста, помогая выявлять смысловые искажения, неоднозначности и логические ошибки.
- Гибкая настройка
Файл конфигурации `docvalidator.properties` позволяет задавать набор проверяемых правил, путь к словарю терминов, формат выходных отчётов и другие параметры.
- Структурированные отчёты
Результаты сохраняются в двух форматах:
- `report.json` – для машинной обработки (например, в CI/CD);
- `report2.html` – для визуального просмотра в браузере.
- Встроенный терминологический словарь
Файл `dictionary.json` содержит базовый набор терминов и может быть легко расширен под нужды конкретного проекта.
> **Примечание:** В каталоге `src/` располагается ядро проверяющей логики на Java, а `semantic_analyzer.py` вызывается из основной программы или может запускаться отдельно.
---
🛠 Используемые технологии
| Компонент | Технологии |
|----------------------|----------------------------------------|
| Основная логика | Java (73.3% кода) |
| Сборка | Maven |
| Семантический анализ | Python (12.7% кода) |
| Визуализация отчётов | HTML (14% кода) |
---
🚀 Сборка и запуск
Требования
- JDK 8 или новее
- Maven 3.6+
- Python 3.7+ (для работы семантического модуля)
Сборка
```bash
git clone https://gitverse.ru/ValuablePrince/DocChecker.git
cd DocChecker
mvn clean package
Запуск проверки
java -jar target/docchecker-*.jar [путь_к_документу_или_папке]
Настройка конфигурации
# Путь к файлу словаря терминов
dictionary.path=dictionary.json
# Включить семантический анализ
semantic.enabled=true
# Формат выходного отчёта (json / html / both)
report.output=both