Smart Documentation System
Wat is het smart documentation system?
Het is een platform om documentatie in op te slaan en te beheren. Daarnaast is het ook mogelijk om deze gemakkelijk te delen met de klant. Voor de klant is het makkelijk om wijzigingen door te voeren aan de documentatie mocht er iets veranderen. Op die manier raakt de documentatie nooit verloren en is er meteen een grote besparing qua papierverbruik.
Over de opdracht
Delta Technics, gelegen te Heist-op-den-berg, bood het project smart documentation system aan. Ik heb in september dit project gekozen uit de lijst met beschikbare projecten en meteen het eerste contact gelegd. Na een korte conversatie heb ik een vergadering ingepland met Delta Technics om de inhoud van het project te bespreken.
Tijdens deze meeting hebben we besproken wat Delta Technics hun visie is over het smart documentation system. Hier kwam uit dat ze een web app wouden hebben om hun papieren documentatie op te uploaden en te beheren. Ze wouden ook graag werken met een QR-code, die de klant dan kan inscannen en wijzigingen kan doorgeven.
De insteek was dat dit zo gemakkelijk mogelijk moest zijn, aangezien techniekers het niet fijn vinden om een uur bezig te zijn met 1 kleine wijziging door te geven.
Tech stack
De mensen van Delta Technics hadden geen voorkeur qua tech stack. Dit gaf mij dus vrij veel opties waardoor ik vrijspel had in deze keuze. Kort daarna heb ik de keuze gemaakt om met Laravel 8 te werken, in combinatie met de Blade template taal en Tailwind CSS voor de styling.
Team
Toen ik duidelijk wist wat de opdracht was en waarmee we gingen werken, kon ik mijn team beginnen samenstellen. Ik heb toen gevraagd aan Thierry Eeman, een voormalig leraar die Toegepaste Informatica is gaan studeren, of hij mee wou werken aan dit project, waar hij met plezier op instemde.
Uitwerking
Allereerst hebben we een projectplanning gemaakt en een Trello-board met alle doelstellingen op. Dit hebben we op de SCRUM manier gedaan. Daarna heb ik het basisproject aangemaakt en deze naar een repo op GitHub gepusht.
Daarna konden we aan de slag en hebben we per sprint een periode van 2 weken genomen. Ieder heeft daarna een user story uit de lijst van de sprint genomen en is hieraan beginnen werken. Bij vragen konden we elkaar iedere keer vlot verder helpen en was de Laravel documentatie een uitstekend hulpmiddel. Tussendoor hebben we nog een ERD gemaakt voor de database en een use case diagram in verband met het vak "Requirements Analysis".
Na onze eerste sprint hebben we een meeting met de klant gehouden om de vooruitgang te tonen. Zij waren op dat moment al blij met hoe het er uit zag en hoe het project verliep.
Onze productiviteit verhoogde naarmate we meer ervaring kregen met Laravel, hierdoor konden we vlot een planning doorgeven aan de klant, en ons hier aan houden.
Oplevering
In de laatste 2 weken van onze planning hebben we nauw samengewerkt met de klant om de applicatie op hun hosting te installeren en configureren. Na de laatste kronkels uit het project uit te werken hebben we een laatste demo gegeven aan de klant en een korte uitleg over hoe alles werkt. Al bij al een zeer succesvolle oplevering!
Open source
Tijdens het ontwikkelen van het project kregen wij het idee dat dit een toepassing is die op meerdere plaatsen toegepast kan worden. Daarom hebben we aan de klant gevraagd of we de code mochten open-sourcen, waarop we een positief antwoord hebben gekregen.
De GitHub repository kan u hier vinden: jonasclaes/smart-documentation-system