Skip to content

Functionele Specificatie ARCHIVED

Koen Teuwen edited this page Jul 16, 2021 · 1 revision

Basic info

  • Disclaimer: Deze specificatie is nog niet compleet.
  • Auteur: Pieter Kokx

Table of Contents

Scenarios

Scenario 1: Kelly

Kelly is secretaresse van GEWIS. Overdag gebruikt zij om diverse redenen de GEWIS-website. Kelly duwt graag haar mening door in poll's en kijkt graag naar foto's van activiteiten. Ook keurt zij als bestuurder poll's goed, en beheert ze de activiteitenagenda en de inschrijflijsten. Ook zoekt ze leuke GEWIS-ers op via foto's en upload ze stukken voor de AV's en BV's. Daarnaast zoekt ze ook vaak naar leuke besluiten in de besluitendatabase.

Overview

De GEWIS Website zal veel verschillende componenten hebben. Hier is een lijstje:

  • Authenticatie (inloggen)
  • Vereniging (informatie over de vereniging)
  • Leden (voor leden zal er een apart stuk op de website, met handige informatie en links)
  • Foto's (foto's van activiteiten)
  • Onderwijs (tentamenarchief, klachten)
  • Polls
  • Bedrijven (informatie van bedrijven, welke betalen voor een positie hier)
  • Activiteitenagenda (en ook inschrijflijsten)

Details

Voel je vrij om de rest van dit document niet al te grondig door te lezen, tenzij je een component zelf aan het schrijven bent. Dan pas heb je de details nodig. Wel is het handig als je een beetje weet waar het over gaat, vooral tijdens vergaderingen.

Layout

De gehele website zal dezelfde basislayout gebruiken:

Layout

Dit is slechts een voorbeeld, de uiteindelijke layout kan er (volledig) anders uitzien.

Authenticatie

Auteur: Pieter Kokx

De authenticatie heeft twee kanten. Een kant voor niet ingelogde gebruikers, en een kant voor ingelogde gebruikers.

Voor niet-ingelogde gebruikers is er de mogelijkheid om in te loggen, te registreren, of om je wachtwoord te resetten.

Ingelogde gebruikers kunnen hun wachtwoord veranderen.

Login

Een voorbeeld voor de login:

Login

Dit formulier geeft 1 mogelijke foutmelding: "Foute login".

Deze pagina zal duidelijke links naar Login aanvragen en Wachtwoord vergeten bevatten.

Login aanvragen (registratie)

Voorbeeld formulier:

Registratie

Hierbij zijn de volgende foutmeldingen mogelijk:

  • Lid met lidnummer x heeft al een account.
  • Lid met lidnummer x bestaat niet.
  • E-mailadres hoort niet bij lidnummer

Als dit formulier verzonden wordt, krijgt het lid op het opgegeven emailadres een mailtje met een activatielink.

Activatie

Activatie

Mogelijke foutmeldingen:

  • Wachtwoord is niet lang genoeg (8 tekens).
  • Wachtwoorden matchen niet.
  • Wachtwoord komt voor in dictionary makkelijke wachtwoorden.

Wachtwoord vergeten

Wachtwood vergeten

Nadat je dit formulier verzendt, zal er een email verstuurd worden met een (unieke) wachtwoord-reset link. Hierna gaat men naar Wachtwoord reset

Mogelijke foutmeldingen:

  • Lid met lidnummer bestaat niet.
  • E-mailadres hoort niet bij lidnummer.

Wachtwoord reset (na vergeten)

Hier krijgt met hetzelfde te zien als bij activatie, met andere tekst. (TODO)

Leden

Auteur: Pieter Kokx

Het ledengedeelte van de GEWIS-website bevat veel onderdelen die alleen voor leden zijn. Voor deze onderdelen moet een gebruiker dus ook ingelogd zijn, en de rechten van GEWIS-lid hebben. De volgende onderdelen zijn er in het ledengedeelte:

  • Eigen gegevens
  • Link naar DreamSpark
  • Smoelenboek
  • Verjaardagen
  • Besluiten
  • Stukken
  • Eventueel nog links naar andere dingen die alleen voor leden zijn (zoals SuSOS)

Eigen gegevens

Hier staan de eigen gegevens voor zover deze bekend zijn bij GEWIS. Dit wordt verder besproken onder het kopje 'Besluitendatabase'.

Smoelenboek

In het smoelenboek kan men zoeken naar andere GEWIS-leden, en daarmee hun adresgegevens vinden.

Over GEWIS leden wordt de volgende informatie weergeven, voor zover bekend bij GEWIS:

  • Naam
  • Adresgegevens (indien er twee adressen zijn; bijvoorbeeld als het lid op kamers woont, zal het kameradres weergeven worden).
  • Geboortedatum
  • Generatie binnen GEWIS (dat is het eerste jaar dat de persoon ingeschreven stond bij GEWIS)
  • Een pasfoto, indien beschikbaar.

Verjaardagen

Hier staan de komende verjaardagen van leden. Dit is een overzicht van 7 dagen, gesorteerd op datum dat men jarig is. Hierbij staat de naam, de datum (in dagen vanaf vandaag), en hoe oud het lid wordt.

DreamSpark

Dit is puur en alleen een doorlink naar DreamSpark. Indien men op deze link klikt, zullen leden doorgestuurd worden naar DreamSpark, en wordt men daarop ingelogd.

Besluiten

Dit wordt besproken in het database gedeelte (TODO).

Stukken

AV Stukken, BV Stukken, beleidsnota, jaarverslagen. Dit is inclusief notulen. Dit wordt ook besproken in het database gedeelte.

Frontpage

Auteur: Pieter Kokx

Op de frontpage zullen de volgende elementen zichtbaar zijn:

  • Agenda
  • "Welkom" tekst, welke links bevat naar pagina's als "Wie we precies zijn" en "wat we doen"
  • Foto van de week
  • Verjaardagen
  • Contactgegevens GEWIS
  • (eventueel) Poll
  • Banner bedrijf

Agenda / Activiteitenkalender

Hier staan alle komende activiteiten. Hier worden maximaal 5 items getoond (op volgorde van begindatum), om het overzichtelijk te houden. Er is de optie om vanuit hier de pagina met alle komende activiteiten te openen. Per activiteit staat er de naam van de activiteit, en de begindatum en einddatum. Alleen items waar de huidige datum (en tijd) nog voor de einddatum valt worden weergeven.

Foto van de week

Uit het fotoarchief wordt elke week een foto bepaald welke deze week de foto van de week zal zijn. Waarschijnlijk zal dit in de nacht van zondag op maandag bepaald worden.

De exacte formule zal hiervoor nog bepaald moeten worden. Deze moet tenminste rekening houden met het volgende:

  • Aantal views in de voorgaande week.
  • Datum van de foto (recentere foto's hebben voorrang).
  • Tags van leden (getagde foto's hebben (lichtelijk) voorrang).

Het moet mogelijk zijn voor beheerders om deze foto te veranderen.

Verjaardagen

Op de frontpage zullen alle leden die vandaag jarig zijn vermeld worden. Hierbij wordt hun leeftijd getoond.

Hiervan zal er van 1 lid een foto worden getoond. Bij het uitkiezen van het lid waar een foto van getoond wordt, houden we rekening met het volgende:

  • Of er een foto beschikbaar is waar die persoon in getagd is.
  • Datum van beschikbare foto's (recentere foto's hebben voorrang).
  • Activiteit van het lid (actieve leden hebben voorrang) NB: Actieve leden zijn leden die in een commissie en/of dispuut zitten.

De foto's welke getoond wordt, wordt bepaald op vergelijkbare wijze als de foto van de week. Dit wordt natuurlijk wel alleen toegepast op foto's waarin het eerder gekozen lid is getagd.

Het moet mogelijk zijn voor beheerders om deze foto te veranderen.

Banner bedrijf

Op de frontpage komt er de mogelijkheid voor bedrijven om banners te plaatsen. De PR-Functionaris moet controle hebben over welke banners hier getoond worden en met welke frequentie. Indien mogelijk in het design, kunnen dit er meerdere zijn.

Onderwijs

Auteur: Pieter Kokx

Het onderwijsgedeelte van de GEWIS-website is ervoor om GEWIS-leden te ondersteunen in hun studie. Dit heeft daarom de volgende onderdelen:

  • Tentamenarchief
  • Boeken
  • Klachten

Het klachtengedeelte is een pagina met informatie over hoe men klachten voor het onderwijs kan overbrengen aan de Onderwijscommissaris. En het boekengedeelte is een pagina met informatie over hoe men studieboeken kan halen bij GEWIS. Verder staan er hier nog een aantal handige links, zoals naar de studentenraad en naar DreamSpark.

Tentamenarchief

Het tentamenarchief bevat oude tentamens van vakken van de faculteit W&I. Dit heeft een aantal verschillende pagina's:

Hoofdpagina

Op de hoofdpagina is er een zoekveld dat naar de Zoekpagina leidt. Daarbij staan er voor de bachelor studies (Wiskunde, Software Science en Web Science), directe links naar de Vakpagina van vakken waar dit kwartiel tentamen van is, geordend op jaargang. Dit zal er niet voor masteropleidingen staan, gezien de diversiteit van de vakken in de masteropleidingen. Ook zijn er links naar de tentamenarchieven van andere verenigingen te vinden. Daarnaast zullen hier links staan naar de tentamenarchieven van nichtjes van GEWIS.

Zoekpagina

Op de zoekpagina is er een zoekbalk (welke ook op de Hoofdpagina staat). Met deze zoekbalk kan er gezocht worden naar vakken, waarbij er gezocht wordt op vakcodes en vaknamen. Als er gezocht is, worden de resultaten hiervan getoond. Hier staan alle vakken die voldoen aan de zoekquery, waarbij het een link naar de vakpagina is.

Vakpagina

Op de vakpagina wordt een geheel vak getoond. Als een vak opgedeeld is in meerdere vakken (zoals bij bachelor college het geval is) wordt dit nog steeds op 1 pagina getoond. Op de vakpagina word de volgende informatie getoond:

  • Vaknaam
  • Vakcode
  • Onderdelen van het vak, indien een vak opgesplitst is in meerdere vakcodes (vooral bachelor college vakken).
  • Oude tentamens (alleen te downloaden indien men op het TU/e netwerk zit, of ingelogd is als GEWIS-lid)
  • Samenvattingen
  • Vergelijkbare vakken
  • Link naar OASE

Bedrijven

Auteur: Jim Stolk

Het bedrijvengedeelte van de GEWIS-site bevat een opsomming van alle commerciële partners die een websitepakket hebben afgenomen. Vacatures van deze bedrijven die interessant zijn voor GEWIS-leden worden ook in dit gedeelte getoond.

Belangrijke onderdelen:

  • Korte introductie over het bedrijf
  • Logo van het bedrijf
  • Contactgegevens van het bedrijf
  • Opsomming van vacatures van dit bedrijf
  • Informatie over wat voor type sollicitant dit bedrijf zoekt, loopbaanontwikkeling en mogelijkheden tot afstuderen
  • Banners van bedrijven op andere plaatsen op de site
  • Management van webpakketten door bestuursleden (met interface)
  • Bedrijf 'in the spotlight'
  • Facaturebank Introductie van bedrijf/logo

Informatie over achtergrond van het bedrijf, korte geschiedenis, recente gebeurtenissen die relevant zijn. Dit alles in markdown. Tabellen moeten hierin mogelijk zijn. Logo van het bedrijf waaruit in één oogopslag de herkenbaarheid aanwezig is, zodat men snel door de lijst kan scrollen. Eventueel referenties/recenties van studenten die al in het verleden met dit bedrijf gewerkt hebben.

Contactgegevens

Basiscontactgegevens, zoals bezoekadres, telefoonnummer, website, directe link naar vacaturepagina op bedrijfswebsite, link naar Google Map van de locaties van dit bedrijf.

In lijst van bedrijven ook mogelijkheid tot sorteren op type bedrijf, type student die het bedrijf interessant zou vinden, aantal vacatures, locatie.

Opsomming vacatures

Lijst van rechtstreekse links naar specifieke vacatures die dit bedrijf aanbied die interessant zijn voor GEWIS-leden. Mogelijkheid tot linken naar vacature op de site van het bedrijf, in plaats van altijd een PDF-bestand.

Informatie type sollicitant

Het is belangrijk dat het GEWIS-lid meteen kan zien of de vacature interessant is voor hem of haar. Hiervoor moet duidelijk zijn aan welk profiel de sollicitant dient te voldoen, wat de mogelijkheden zijn tot loopbaanontwikkeling en eventuele opties voor afstuderen. Dit kan aan de hand van kleine icoontjes, die bijvoorbeeld aangeven of deze vacature interessant is voor TI of WSK studenten, masters of bachelors, afstudeerders etc.

Management van webpakketten

De functionaris PR (en eventueel andere bestuursleden) kan bedrijven die een webpakket hebben zelf op de website zetten, en daarbij aangeven wat de verloopdatum van het pakket is. Zodra deze verloopdatum in zicht komt ontvangt hij/zij een automatisch gegenereerde notificatie dat het desbetreffende pakket binnenkort verloopt. Eventuele verlopen pakketten worden niet meer getoond na verloopdatum, maar blijven wel bewaard zodat deze makkelijk gereactiveerd kunnen worden als het bedrijf het pakket vernieuwt.

Bedrijf 'in the spotlight'

Per tijdvak (bijvoorbeeld week/maand etc.) 1 specifiek bedrijf in de spotlight zetten door grote banner bovenaan de bedrijvenpagina, met een of meerdere referenties/recenties van studenten die eerder in contact zijn geweest met dit bedrijf.

Vacaturebank

Het moet ook mogelijk zijn om alle vacatures van alle bedrijven in 1 lijst. Hier moeten ook bedrijven zonder profiel, maar met een webpakket in kunnen staan. Op het moment dat het pakket verlopen is worden de vacatures ook hier niet zichtbaar. Vacatures zijn gecategoriseerd in drie categorieën:

  1. Bijbaan
  2. Afstudeerproject / stage
  3. Na je studie

Inzenden vacatures

Vacatures moeten door externe instellingen kunnen worden ingezonden. Iemand met bestuursrechten moet deze vacatures kunnen accepteren.

Administratie interface

Bestuursleden kunnen via een admin interface vacatures accepteren, plaatsen, aanpassen en wissen.

Foto's

Auteur: Mike van Drunen

Het fotogedeelte van de GEWIS-site bevat een hiërarchische structuur voor de foto's in de vorm van fotoalbums. Hierbij wordt onderscheid gemaakt tussen de root en albums. In de root kunnen geen foto's geplaatst worden, alleen albums. Het zou onoverzichtelijk worden als er foto's in de root zouden staan. In albums kunnen zowel foto's als subalbums geplaatst worden. De foto's en subalbums worden dan apart gegroepeerd.

Het fotogedeelte bevat de volgende onderdelen:

  • Albums
  • Foto's
  • Tags
  • Uploaden
  • Beheer

Albums

Albums moeten een compositie van afbeeldingen als icoon hebben. Bij het album moeten de volgende gegevens beschikbaar zijn: titel, auteur, periode waarin de foto's genomen zijn en het aantal foto's in het album of in de subalbums. Verder bevat een album onbeperkt aantal subalbums of een onbeperkt aantal foto's.

Foto's

Foto's worden in miniatuur weergegeven in albums. Ze worden van links naar rechts weergegeven waarbij deze oplopend op datum/tijd gesorteerd worden. Door op een miniatuur te klikken wordt de volledige foto weergegeven. Hierbij worden naast de titel, auteur ook gegevens van de camera weergegeven zoals sluitersnelheid etc. De metadata is alleen toegankelijk voor ingelogde gebruikers. Er moet een link weergegeven worden waar de hoge resolutie foto weergegeven wordt.

Tags

In foto's kunnen GEWIS-leden getagd worden. Waar mogelijk zullen gezichten herkend worden in foto's en kunnen tags bij een gezicht toegevoegd worden. Er zal bij de foto tekstueel weergegeven worden wie er getagd zijn in een foto. Klikken op de naam zal leiden naar een overzicht van alle foto's waar de betreffende persoon in getagd is. De tag moet verwijderd kunnen worden door het betreffende lid, een admin of bestuurder.

Uploaden

Bestuurders kunnen nieuwe foto-albums aan de website toevoegen, en nieuwe foto's uploaden voor bestaande albums. Bij het toevoegen van foto's, kan er gekozen worden om deze foto's uit een directory op de server te halen of om deze te uploaden.

Beheer

Geautoriseerde accounts (GEFLITST, aangewezen persoon van bestuur, WEB) moeten on-the-fly foto's kunnen toevoegen aan een album, foto's verwijderen uit een album, foto's en albums verplaatsen naar andere albums, tags beheren en album namen kunnen aanpassen. Albums worden op een overzichtelijke manier weergegeven zodat gemakkelijk een album of sub-album geselecteerd kan worden. Na het selecteren van een album zullen de sub-albums en foto's van het betreffende album worden weergegeven. Verder zullen er knoppen verschijnen om verschillende operaties uit te voeren op een album. Hierbij zullen er knoppen zijn voor de volgende functies:

  • Album bewerken
  • Photo's toevoegen
  • Album verplaatsen (in het geval van een sub-album)
  • Een nieuwe cover photo genereren
  • Album verwijderen

Op alle foto icoontjes wordt een selectie vakje weergegeven waarmee meerder foto's tegelijkertijd geselecteerd kunnen worden. Vervolgens kunnen meerdere foto's tegelijkertijd verwijderd of verplaatst worden. Bij het bewerken van een album kan het volgende worden aangepast:

  • Titel
  • Periode waarin de foto's genomen zijn

Het toevoegen toevoegen van een album gebeurt door op een knop te klikken in het album overzicht. Als er op dat moment al een album wordt weergegeven zal er een sub-album daarvan aangemaakt worden. Bij het aanmaken van het album kan een naam gekozen worden. Vervolgens kunnen aan het nieuwe album foto's toegevoegd worden. Dit kan door foto's te uploaden of door foto's te importeren vanaf een opgegeven pad of de server. De datum range wordt automatisch ingesteld op het moment van de eerste foto tot het moment van de laatste foto, maar dit kan aangepast worden. Een cover foto voor het album wordt automatisch gegenereerd in de vorm van een compositie van meerdere willekeurige foto's uit het album of subalbums daarvan. Er is altijd een mogelijkheid om een nieuwe cover foto te genereren met andere foto's.

Besluitendatabase

Auteur: Marcel Visser

Vergaderingendatabase

De vergaderingendatabase van de GEWIS-website is alleen voor leden. Voor deze onderdelen moet een gebruiker ingelogd zijn, en de rechten van een GEWIS-lid hebben. Leden kunnen de documenten op de ondergenoemde pagina's downloaden in PDF-formaat.

Belangrijke onderdelen

  • AV notulen, de secretaris kan deze toevoegen wanneer dit nodig is.
  • AV stukken, de secretaris kan deze toevoegen wanneer dit nodig is.
  • Beleidsnota's, het huidige bestuur kan hier hun eigen versie aan toevoegen.
  • BV notulen, de secretaris kan deze toevoegen wanneer dit nodig is.
  • Jaarverslagen, het huidige bestuur kan hier hun eigen versie aan toevoegen.

Verder moet deze database een zoekfunctie beschikken om stukken/notulen op datum/naam/orgaan te zoeken en een duidelijk overzicht bevatten. Het hele bestuur moet de mogelijkheid hebben hier nieuwe stukken te plaatsen. Ook moet het huidige bestuur de optie hebben om een stuk te editen of verwijderen, in het geval van een fout.

Besluitendatabase

De besluitendatabase van de GEWIS-website is alleen voor leden. Voor deze onderdelen moet een gebruiker dus ook ingelogd zijn, en de rechten van een GEWIS-lid hebben. Leden kunnen de documenten op de ondergenoemde pagina's downloaden in PDF-formaat.

Belangrijke onderdelen

  • Actieve organen
  • Besluiten
  • Verloop
  • Informatie
  • Virtuele vergadering
  • Voorzittersvergadering

Onder Actieve Organen vallen de commissies der GEWIS. Onder deze pagina kunnen de besluiten, verloop en informatie over deze commissie gevonden worden. Deze database moet een zoekfunctie op datum/naam/orgaan hebben. De virtuele/voorzittersvergaderingen bevatten besluiten die op deze specifieke vergaderingen genomen zijn. De secretaris moet de mogelijkheid hebben om hier informatie aan toevoegen zodra er mutaties plaatsvinden. De database moet een zoekfunctie bevatten zodat er gezocht kan worden in de verschillende besluiten, zowel op datum als op naam. Besluiten moeten aanpasbaar zijn voor het geval dat de secretaris een fout maakt.

Activiteitenkalender

Auteur: Wout de Ruiter

De activiteitenkalender van GEWIS is een lijst van activiteiten die voor GEWIS leden worden georganiseerd en met goedkeuring van het bestuur in deze lijst worden gezet. Deze lijst is voor leden zichtbaar.

Belangrijke onderdelen:

  • GEWIS'ers kunnen de activiteiten kalender bekijken
  • Activiteit eigenschappen (inschrijflijst, kosten, plaats, datum)
  • De activiteiten kunnen worden aangemaakt door organen GEWIS
  • Activiteiten kunnen worden gewijzigd door de organiserende partij
  • Inschrijven activiteit
  • Activiteit miniaturen die op andere plaatsen op de site kunnen worden gebruikt

Activiteiten kalender bekijken

Activiteiten vormen een belangrijk onderdeel van GEWIS en zal een van de hoofdredenen zijn waarom normale GEWIS'ers naar de site zullen gaan. Hierdoor zal het belangrijk zijn dat de activiteitenkalender goed zichtbaar is op de site dan wel snel vindbaar is. In deze lijst kan je denken aan een opsomming van activiteiten met details hiervan.

Activiteit eigenschappen

Een activiteit moet een begindatum, een einddatum, een locatie, en kosten veld en een inschrijflijst kunnen hebben. De inschrijflijst en het kostenveld zijn hierbij optioneel. De inschrijflijst moet verschillende extra mogelijkheden kunnen hebben waarbij inschrijvers hier een keuze in kunnen maken of deze kunnen invullen. Deze extra mogelijkheden kunnen onderlinge afhankelijkheden hebben. Zo zou je je een eet lijst voor kunnen stellen waar pizza of chinees besteld kan worden. Hierbij zou je dan alleen iets bij pizza kunnen invullen als chinees leeg is. Ook heeft de inschrijflijst een sluitingsdatum of kan deze handmatig door de organisator worden gesloten en geopend, het bestuur kan dit ook doen.

Aanmaken activiteiten

Activiteiten kunnen worden aangemaakt door organen van GEWIS. Nadat dit verzoek is ingediend wordt het verzoek voorgelegd aan het bestuur dat vervolgens bepaald of het verzoek in de activiteiten kalender wordt gezet. Als het verzoek is goedgekeurd kan het ten allen tijden worden weggehaald door de organiserende partij.

Aanpassen activiteiten

Een activiteit kan ten alle tijden door de organiserende partij worden verwijderd. De activiteit kan echter alleen worden gewijzigd met toestemming van het bestuur. Bij het wijzigen van de extra mogelijkheden zijn er geen wijzigingen voor degene die zich hebben ingeschreven. De nieuwe extra mogelijkheden, dan wel afhankelijkheden ten opzichte van elkaar, gelden wel voor de nieuwe inschrijvingen.

Inschrijven activiteit

Afhankelijk van de activiteit kunnen alleen GEWIS leden of iedereen inschrijven. Bij het inschrijven van de activiteit moeten ook de extra velden naar behoren zijn ingevuld. Zodra de inschrijflijst is gesloten kan men zich niet meer uitschrijven voor een activiteit. Hiervoor kan dit natuurlijk wel.

Activiteit miniaturen

Omdat activiteiten tof zijn wil je ze niet alleen op de activiteitenkalender weergeven maar ook standaard in een van de miniatuur items in de zijkant van het scherm. Dit zou een beknopte versie van de activiteit zijn. Denk hier aan titel, datum, locatie en kosten.

TODO

  • Link naar SuSOS. Dit moet nog ergens verwerkt worden, hierbij moet er aan gedacht worden dat ook niet-leden bij SuSOS moeten kunnen komen.
  • Misschien een pagina die informatie over de GEWIS-irc weergeeft.

Verdeling stukjes:

wie wat Done?
Marcel Functioneel ontwerp besluitendatabase. YES!
Mike Functioneel ontwerp Foto's. YES!
Jim Functioneel ontwerp Bedrijven. YES!
Pieter Functioneel ontwerp Onderwijs. YES!
Pieter Functioneel ontwerp Frontpage. YES!
Pieter Functioneel ontwerp Leden. YES!
Wout Functioneel ontwerp Activiteitenkalender. YES!
Clone this wiki locally