DocsLint

Программное обеспечение «DocsLint» (www.docslint.ru) представляет собой веб-приложение, предназначенное для автоматизированного контроля качества документации. Система обеспечивает анализ структуры и полноты документов, проверку навигации, выявление битых ссылок, контроль соблюдения установленных требований к документации, а также формирование отчетов по результатам выполненных проверок.
ПО «DocsLint» используется для централизованной проверки документации, размещенной во внешних репозиториях, и предоставляет пользователю средства для управления проектами, запуска проверок, просмотра результатов анализа, ведения истории проверок и применения корпоративных правил контроля качества. В составе системы также реализованы средства интеграции с процессами CI/CD, механизмы анализа журналов сборки и инструменты формирования аналитических представлений по результатам контроля.

Функциональные характеристики

• регистрация и авторизация пользователей через веб-интерфейс системы
• ведение личного кабинета пользователя
• разграничение прав доступа по ролям пользователей
• управление организациями, пользователями и проектами документации
• создание, редактирование, копирование и удаление проектов
• подключение Git-репозиториев для анализа документации
• настройка параметров проекта и указание корневого раздела документации для проверки
• автоматическое определение ветки и коммита анализируемого репозитория
• запуск автоматизированной проверки документации по заданным правилам
• анализ структуры документации и контроль наличия обязательных разделов
• анализ навигации по документации и выявление документов, не включенных в навигационную структуру
• выявление изолированных документов
• выявление битых ссылок и ошибок ссылочной целостности
• выявление пустых, коротких и структурно неполных документов
• применение корпоративных стандартов и правил проверки документации
• настройка, изменение и применение корпоративного стандарта проверки документации с ведением журнала его изменений
• хранение, редактирование и версионирование стандартов проверки
• настройка корпоративных правил расчета итоговой оценки документации
• проверка терминологии, единообразия формулировок и стилевых ограничений
• контроль использования обязательных терминов и выявление нежелательных вариантов формулировок
• контроль эмоционально окрашенных и разговорных формулировок
• применение готовых профилей и шаблонов правил проверки документации
• формирование сводки результатов проверки и итоговой оценки качества документации
• отображение детализации факторов, влияющих на итоговую оценку
• построение карты документации и визуальное представление структуры разделов
• ведение истории проверок по каждому проекту
• ведение журнала событий проекта
• формирование и хранение отчетов по результатам анализа
• экспорт и хранение HTML-отчетов
• выполнение разового аудита загруженных файлов (DOCX, PDF, MD, RST)
• выполнение разового аудита Git-репозиториев с проверкой комплектности документации и оценкой ее готовности к публикации и выпуску релиза
• анализ изменений по журналу изменений и коммитам репозитория
• формирование рекомендаций по исправлению выявленных нарушений
• прием результатов CI/CD-процессов сборки документации
• анализ журналов сборки и выделение диагностических сообщений
• применение ИИ-компонента для расшифровки и интерпретации журналов сборки и результатов аудита
• ведение истории сборок, отображение аналитических сведений и графиков по результатам проверок
• генерация и использование проектного токена интеграции для подключения CI/CD-агентов
• выполнение массовой перепроверки проектов при изменении стандартов или параметров контроля
• централизованный мониторинг качества документации по всем проектам организации
• отображение агрегированных показателей и сводок на панели контроля состояния документации
• фоновая обработка заданий анализа и перепроверки.