MVN Documentator

Въведение

Целта на системата е да автоматизира и улесни процеса по създаване на документация на софтуерни проекти, като включва полезна информация за тях, представена нагледно и в удобен за четене вид. Потребителите прикачват информация за желаните от тях проекти в лесен за представяне формат и избират стил на документацията според предпочитанията си от няколко предефинирани темплейта. В резултат се генерира сайт с подадената информация и според избрания дизайн. Системата е предназначена за всички страни, включени в процеса на софтуерна разработка.

Инсталация и настройки

Машината, на която се пуска системата, трябва да има инсталирани:

• Maven
• XAMPP, MySQL

При първоначално стартиране на приложението, се изпълнява автоматично SQL скрипт, който създава необходимата база данни, таблици и полета. Съответно при всяко следващо стартиране на системата, се прави проверка дали базата данни и таблиците съществуват и само ако не съществуват се създават отново.

Технологии

• Front-end: HTML, CSS, JavaScript
• Back-end: PHP, Maven
• Database: MySQL

Входни данни

Данните, които системата приема, са във формат CSV. В CSV файла се описва информацията за проекта и участниците в него. За да предостави гъвкавост на потребителя, системата позволява включването на данни за неограничен брой участници.

Съдържание на документацията

Проекти:

• Номер и заглавие на проекта
• Описание
• Ресурси – препоръчани и използвани
• GitHub линк
• Информация за презентиране: дата, час, линк към BBB

Участници (неограничен брой)

• Име
• Фамилия
• Специалност
• Курс
• Факултетен номер
• Разпределение на задачите
• Време за работа по проекта (човекочаса)