Сложные карты. Надёжная основа.
Помогли укрепить техническую основу сервиса управления картами: рефакторинг, более 400 тестов за три месяца и документация API.
- Наш вклад
- Рефакторинг, автоматические тесты и документация
- Продукт
- Геоинформационные
Разобраться в коде
Изучить существующий проект и определить, что можно улучшить.
Провести рефакторинг
Переработать код и устранить выявленные недостатки.
Проверить поведение
Покрыть проект модульными, интеграционными и системными тестами.
Описать API
Подготовить документацию для работы с программным интерфейсом.
О проекте
Mapic — норвежский инструмент для публикации и управления геоданными. Он позволяет работать со слоями карт без программирования. Мы подключились к существующему продукту, чтобы улучшить код, проверить его поведение и подготовить документацию для дальнейшей разработки.
Порядок внутри продукта
Удобный инструмент для работы с картами требует внимания к тому, что скрыто за интерфейсом. Наш старший разработчик провёл рефакторинг Mapic: работа была сосредоточена на существующем коде и его качестве. Это вклад в техническую основу, на которой команда может развивать продукт.
Проверки на трёх уровнях
За три месяца мы написали более 400 тестов на Mocha — модульных, интеграционных и системных. Такой набор позволяет проверять как отдельные части программы, так и их взаимодействие и поведение системы в целом.
Тестирование помогло обнаружить ошибки и недочёты, которые мы устранили в ходе работы. Автоматические проверки сохраняют пользу и после исправления: их можно повторять при последующих изменениях кода.
API, с которым проще работать
Мы подготовили полную документацию проекта с помощью apidoc.js. Описанный программный интерфейс помогает разработчикам ориентироваться в возможностях системы и обращаться к ним без постоянного погружения в реализацию.
Основа для следующих изменений
Сотрудничество было коротким, но охватило три связанных направления: качество кода, автоматическую проверку и документацию. Вместе они делают дальнейшую работу над продуктом понятнее и помогают команде увереннее вносить изменения.
Mapic: что изменилось
Более 400 тестов
Модульные, интеграционные и системные проверки на Mocha. Найденные при тестировании ошибки и недочёты исправлены.
3 месяца
За этот срок написали более 400 тестов, создав основу для автоматической проверки изменений.
Документация API
Подготовили полную документацию проекта с помощью apidoc.js.
Технологии проекта
Стек, с которым мы работали над Mapic.
Node.js
Серверная среда JavaScript
Express
Серверный веб-фреймворк
MongoDB
Документная база данных
JavaScript
Язык разработки
CSS
Оформление интерфейса
Lodash
Утилиты для работы с данными
Mocha
Запуск автоматических тестов
Chai
Проверка ожидаемых результатов
Sinon
Подмена зависимостей в тестах
apidoc.js
Документация программного интерфейса
У вашего продукта — своя задача.
Обсудим, что нужно вашим пользователям и как превратить это в работающий продукт.