FMF
Москва, ул. Большая Ордынка, 17
Телефон: 8 800 333-11-26
Почта: info@fmf.dev

Аудит, инструкции, создание wiki-портала с AI-помощником

Изображение Изображение
Клиент и задачи

Клиент: Одна из ведущих компаний в автомобильной отрасли.

Цели проекта:

  • Улучшение качества документации IT-системы.
  • Повышение эффективности работы команды через централизованный доступ к информации.
  • Оптимизация системы для повышения производительности и безопасности.
  • Упрощение процесса адаптации новых сотрудников к системе.

Сроки реализации: 3 месяца (2024 год)

Анализ бизнес-процессов

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

Услуга
Аудит и описание бизнес-процессов
Комплексная аналитика вашего бизнеса для максимальной эффективности цифровой трансформации
Подробнее

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

Задачи проекта

В рамках проекта мы ставили перед собой ключевые задачи, направленные на улучшение текущей IT-системы клиента.

Основное внимание было уделено проведению аудита, созданию детальной технической документации и разработке инструкций для пользователей. Не менее важным было создание wiki-портала со встроенным AI-помощником, а также предложили рекомендации по оптимизации и безопасности системы.

  • Провести аудит текущей IT-системы, выявить потенциальные проблемы и риски

  • Создать детальную техническую документацию, включая архитектуру системы, API, базы данных и бизнес-логику

  • Разработать инструкции для конечных пользователей, администраторов и разработчиков

  • Внедрить wiki-портал с AI-помощником для удобного доступа, обновления и управления документацией

  • Предложить клиенту рекомендации по оптимизации, масштабированию и повышению безопасности системы

Исходные данные и вызовы

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

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

Фрагментированная документация

Информация о системе хранилась в разрозненных файлах или не была задокументирована вовсе

Сложности с поддержкой

Отсутствие единого источника информации усложняло работу технических специалистов

Проблемы с масштабируемостью

Система развивалась без четкой структуры, что создавало потенциальные узкие места в производительности

Отсутствие удобного доступа к документации

Новые сотрудники тратили слишком много времени на поиск нужной информации

Необходимость инструкций

Пользователям и администраторам было сложно работать с системой из-за отсутствия понятных руководств

Этапы реализации

Технический аудит

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

Создание технической документации

  • Описание архитектуры системы и её компонентов.
  • Документация API (спецификации, методы, параметры, примеры использования).
  • Моделирование структуры баз данных, описание их связей и оптимизационных возможностей.
  • Фиксация бизнес-логики процессов в системе.

Разработка инструкций

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

Внедрение wiki-портала

  • Выбор и настройка удобной платформы для ведения документации (Wiki.js)
  • Разработка структуры вики-портала:
    • Главная страница с быстрым доступом к ключевым разделам.
    • Блок технической документации (архитектура, API, базы данных).
    • Раздел с инструкциями для пользователей и администраторов.
    • Чат и система комментариев для обратной связи и обсуждения вопросов.
  • Настройка прав доступа для разных категорий пользователей (разработчики, администраторы, менеджеры).
  • Разработка механизма быстрого поиска информации.
  • Обучение команды заказчика работе с вики-порталом.

Оптимизация и рекомендации

  • Выявление узких мест и предложенные улучшения в архитектуре системы.
  • Оптимизация работы базы данных для повышения скорости обработки запросов.
  • Рекомендации по повышению безопасности системы и защите данных.
  • Предложения по автоматизации рутинных процессов.

Внедрение AI-помощника

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

Преимущества вики-портала

Централизованное хранилище

Вся документация доступна в одном месте, упрощая поиск нужных данных

Актуальность информации

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

Удобная навигация и поиск

Гибкая система тегов и категорий, позволяющая быстро находить необходимые материалы

Контроль версий

Вся история изменений сохраняется, что позволяет восстанавливать старые версии файлов

Гибкие права доступа

Разные уровни доступа для сотрудников: редактирование или только чтение

Совместная работа

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

Результаты проекта

Иконка

Систематизированная документация

Клиент получил полный пакет актуальных технических документов в удобном формате

Иконка

Упрощение поддержки

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

Иконка

Оптимизация работы системы

Рекомендации позволили сократить время обработки данных и повысить стабильность

Иконка

Снижение рисков

Аудит выявил уязвимости и потенциальные проблемы, что позволило их устранить до возникновения критических сбоев

Иконка

Ускорение адаптации новых сотрудников

Благодаря вики-порталу команда заказчика быстрее осваивает систему.

Иконка

Гибкость и удобство работы с документацией

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

Аудит, разработка документации и внедрение вики-портала стали важными шагами в повышении эффективности работы IT-системы клиента. Теперь его команда имеет полный доступ к актуальной информации, а бизнес – четкий план по дальнейшему развитию и масштабированию решения.