Danko - Tomcsanyi - specifikacia

From Princípy tvorby software

Jump to: navigation, search

Software Requirements Specification for "E-learningový systém pre školu e-BRAING"
Version 1.0 approved
Prepared by Juraj Danko, György Tomcsányi
14.03.2010

Contents

Úvod

Účel

Dokument špecifikuje popis požiadaviek pre aplikáciu "E-learningový systém pre školu". Jej účelom je poskytnutie nasledujúcej funkcionality:

  • V učiteľskom rozhraní: kreovať lekcie,testy a projeky a prideľovať ich študentom (žiakom)
  • Tieto testy, lekcie a projekty sú viditeľné študentom (žiakom), možnosť práce na nich
  • Učiteľ sleduje úspešnosť študentov (žiakov) a ich projekty
  • Vzájomná komunikácia prostredníctvom IM
  • Vymieňanie zadaní medzi učiteľmi
  • Globálny pohľad riaditeľa na systém
  • Rodičia sledujú postup detí a prideľujú im zadania

Konvencie dokumentu

Tabuľka použitých skratiek a pojmov

Skratka/Pojem Popis

IM

Instant Messanger; chat

JScript

JavaScript

Úlohy

lekcie, testy, projekty

Cieľové skupiny

Žiaci, rodičia, učitelia, vedenie školy.

Všeobecný popis

O produkte

e-BRAING bude naprogramovaný v PHP a ASP.NET v spolupráci s databázou Oracle. Komunikačné rozhranie bude vedené sieťou internet, používajúc technológie xHTML, CSS, JScript. Produkt bude licencovaný pre školy Ministerstvom školstva Slovenskej Republiky alebo inou na to určenou organizáciou v prípadnom výnose ministerstva. Update, upgrade a technická podpora budú zahrnuté v cene produktu.

Funkcie produktu

  • Pridávanie nových učiteľov, rodičov, žiakov a riaditeľov
  • Správa personálnych nastavení (profilov)
  • Management a publikovanie zadaní a úloh učiteľmi aj rodičmi študentov
  • Vymieňanie zadaní medzi učiteľmi
  • Práca na úlohách (študenti)
  • Hodnotenie úloh učiteľmi
  • Prehľad úloh pre všetky zúčastnené strany
  • Analýza stavu systému a úloh riaditeľom a administrátorom

Užívateľské skupiny

V dokumente sú presne vymedzené používateľské skupiny, pričom jeden človek môže byť začlenený v najviac jednej.

Administrátor

Administrátor aplikácie. Má prehľad o celkovej činnosti a stave systému. Správa užívateľov a možnosť modifikácie všetkých entít.

Riaditeľ

Pozorovacia a kontrolná činnosť. Riaditeľ je aj učiteľom.

Učiteľ

Manažuje študentov a úlohy. Hodnotí ich, sleduje postup riešenia a riadi tiež projekty. Možnosť komunikácie so študentami prostredníctvom IM. Vie zdieľať úlohy s ostatnými učiteľmi.

Žiak

Modifikuje svoje osobné nastavenia, rieši úlohy jemu priradené učiteľmi a rodičmi. Sleduje stav svojho štúdia a môže konzultovať s učiteľmi prostredníctvom IM.

Rodič

Sleduje činnosť svojho dieťaťa, prípadne mu zadáva dodatočné testy.

Externé rozhranie

Hardvérové rozhranie

  • Aplikačný server - predpokl. Intel Xeon (2 alebo viac jadier) alebo kompatibilné
  • Databázový server - predpokl. Intel Xeon (2 alebo viac jadier) alebo kompatibilné
  • Koncové stanice - IBM kompatibilné PC s výkonom 2 GHz alebo viac, architektúra x86-32, x86-64 alebo kompatibilná, 1 GB RAM, polohovacie zariadenie, vstupné klávesové zariadenie, vizuálne farebné výstupné zariadenie (monitor alebo iné kompatibilné)

Softvérové rozhranie

  • Aplikačný server - MS Windows Server 2003 alebo vyššie, Apache, PHP5, ASP.NET
  • Databázový server - Oracle 11g alebo kompatibilné
  • Koncové stanice - MS Windows 2k/XP/Vista/7 x86-32 alebo x86-64 verzia, Linux s jadrom 2.6.x alebo vyššie, prehliadač internetu podporujúci JavaScript, HTML, CSS, renderovanie obrázkov (.JPG, .PNG, .TGA, .BMP)

Komunikačné rozhranie

HTTP, HTTPS - metódy POST, GET, PUT a DELETE, AJAX, e-mail slúžiaci aj na kontakt s administrátorom, IM protokol jabber alebo kompatibilný

Funkcie systému

V tejto kapitole sú popísané funkcie systému.

Manažovanie úloh

Opis a priorita

Učitelia budú mať možnosť vytvárať nové zadania, pridelovať ich žiakom, hodnotiť ich, a vymienať si ich s kolegami

Priorita: vysoká

Odpoveď systému

Systém učitelovi na požiadanie zobrazí zoznam už vytvorených úloh. Má možnosť vytvoriť nové úlohy, pridelovať ich žiakom a poslať kolegom. Systém na požiadanie zobrazí tiež aktuálny stav pridelených úloh, kde vie učiteľ sledovať prácu žiakov a hodnotit ich.

Funkcionálne požiadavky

  1. Systém zobrazí tabuľku úloh.
  2. Jednotlivé úlohy bude možné editovať, pridelovať študentom a posielať kolegom.
  3. Úlohy majú nasledujúce nastavenia: ktorím študentom je pridelený, kedy ho môžu študenti začať riešiť a koľko času majú na riešenie.
  4. Bude možné sledovať stav pridelených úloh vo forme tabuľy. Tieto údaje bude možné filtrovať a triediť podľa údajov žiaka (meno, trieda), predmetu, a stavu úlohy (rozpracovaná, odovzdaná).
  5. Odovzdané úlohy môže učiteľ otvoriť a ohodnotiť.
  6. V dalšej tabuľke sa zobrazí prehľad ohodnotených úloh. Tieto údaje je bude možné filtrovať a triediť podobne ako v bode 3.

Manažovanie študentov

Opis a priorita

Poverená osoba (administrátor a učiteľ) bude vedieť pridávať nových študentov, pridelovať ich do tried a skupín.

Priorita: vysoká

Odpoveď systému

Systém zobrazí zoznam študentov a na žiadosť pridá nových žiakov do databázy a zmení im údaje.

Funkcionálne požiadavky

  1. Všeobecné údaje uložené v databáze: meno, priezvisko, rodné číslo, adresa, telefónne číslo, fotografia, predstavenie (viď Editácia profilu)
  2. Špecifické údaje:
    1. Študent: trieda, ročník, mená rodičov
    2. Rodič: mená detí
    3. Učiteľ: predmety ktoré učí, pridelené triedy
  3. Systém zobrazí tabuľku študentov. Tabuľku bude možné triediť a filtrovať podľa ľubovolného atribútu.
  4. Poverená osoba môže zmeniť údaje študentov.
  5. Na žiadosť systém zobrazí formulár na pridávanie nových žiakov, ktorých potom uloží do databázy.

Sledovanie štúdia a výsledkov

Opis a priorita

Učiteľ/rodič/študent bude môcť sledovať výsledky svojich žiakov/vlastné/svojich detí.

Priorita: stredná

Odpoveď systému

Systém učiteľovi zobrazí zoznam jeho študentov s výsledkami úloh. Bude mať možnosť filtrovať a triediť podľa mena, triedy a predmetu. Po výbere študenta sa mu zobrazia ďalšie informácie o odovdaných úlohach, kde bude vidieť aké chyby študent spravil v testoch. Systém rodičovi zobrazí údaje jeho detí, a študentovi len jeho vlastné.

Funkcionálne požiadavky

  1. Systém zobrazí výsledky len tých študentov ku ktorím ma prihlásená osoba prístup.
  2. Tabuľka bude obsahovať bodové ohodnotenie jednotlivých úloh a celkové hodnotenie študenta.
  3. V údajoch bude možné vyhľadávať a ďalej ich filtrovať a triediť.
  4. Bude možné zobraziť riešenie študenta a zoznam jeho chýb.

Zadanie testu dieťaťu

Opis a priorita

Umožní rodičovi vytvoriť test, ktorý bude riešiť jeho dieťa.

Priorita: Stredná

Odpoveď systému

Systém zobrazí zoznam rodičom vytvorených testov. Tu môže rodič vidieť prospech dieťaťa v týchto testoch. Je možné vytvoriť nový test, ktorý systém prirádí dieťaťu.

Funkcionálne požiadavky

  1. Rodič môže zadávať rôzne testy, a nastaviť ich: komu bude úloha pridelená (viď bod 2), od kedy má byť test prístupný pre dieťa a koľko času má na riešenie.
  2. V systéme bude môcť rodič manažovať aj viac detí.
  3. Systém zobrazí zoznam všetkých testov ktoré rodič zadal. Bude zobrazený stav testu (pridelený a vyriešený). Ďalej tu bude možné jednotlivé vyriešené testy otvoriť, a pozrieť riešenie dieťaťa.

Riešenie úloh

Opis a priorita

Študent bude mať možnosť prezerať jemu priradené úlohy a riešiť ich.

Priorita: vysoká

Odpoveď systému

Systém študentovi zobrazí zadania, ktoré mu boli pridelené učiteľom alebo rodičom. Študent si môže vybrať úlohu, ktorá sa mu zobrazí, a potom ju riešiť. Po ukončení študent odovzdá zadanie, a systém oznámi zadávateľovi ukončenie zadania.

Funkcionálne požiadavky

  1. Systém zobrazí zoznam úloh. Tie bude možne triediť a filtrovať podľa zadávateľa, predmetu a času do dedlajnu.
  2. Po vybratí úlohy sa zobrazia bližšie informácie ako téma zadania, pripomienky učiteľa a čas na riešenie.
  3. Úlohu je možné začať riešiť najneskôr v čase určenom zadávateľom.
  4. Študent má na vypracovanie úlohy čas určený zadávateľom.
  5. Po začatí úlohy bude zobrazený čas zostávajuci do odovzdania. Študent môže zadanie odovzdať do vypršania časového limitu, po tom sa úloha automaticky odovzdá.
  6. Po odovzdaní úlohy na ňom už študent nemôže viac pracovať. Úloha sa pošle zadávateľovi na ohodnotenie. Študent si neskôr môže pozrieť jeho výsledky ako bolo popísané v Sledovanie štúdia a výsledkov.

Editácia profilu

Opis a priorita

Učiteĺ, rodič a študent bude mať profil. Tu bude mať každý uložené základné osobné údaje, fotku prípadne predstavenie.

Priorita: nízka

Odpoveď systému

Uživateľ systému si bude môcť zmeniť vlastnú fotku a predstavenie. Osobné údaje sa vyplnia pri vytváraní uživateľa (viď Manažovanie študentov), ďalšie zmeny môže robiť len osoba vytvárajúca profil, riaditeľ a administrátor.

Funkcionálne požiadavky

  1. Systém umožní prehliadanie profilov ostatných a editáciu vlastného profilu.
  2. Osobné údaje sa zadávajú pri registrácií, neskôr ich môže meniť len poverená osoba.

IM komunikacia

Opis a priorita

Učiteľ a študent môžu komunikovať prostredníctvom IM.

Priorita: stredná

Odpoveď systému

Systém vygeneruje GUI za účelom umožnenia IM komunikácie medzi konkrétnymi používateľmi. Študentovi zobrazí zoznam učiteľov, učiteľovi zoznam jeho študentov. Po vybratí konkrétneho používateľa sa otvorí komunikačné okno.

Funkcionálne požiadavky

  1. Systém umožní zobrazenie používateľov dostupných pre IM komunikáciu.
  2. Systém vygeneruje okno umožňujúce komunikáciu prostredníctvom protokolu Jabber.

Ceľkový prehľad a kontrola

Opis a priorita

Riaditeľ školy bude mať možnosť vygenerovať náhľad registrovaných užívateľov. Bude kontrolovať priebeh vzdelávania a hodnotenia. Tiež mu bude umožnené editovať nastavenia jednotlivých osobných účtov.

Priorita: vysoká

Odpoveď systému

Riaditeľ si bude môcť vybrať používateľa, ktorého bude kontrolovať/editovať. Pri editácii používateľa mu bude umožnené zmeniť jeho voľby. Pri kontrole výsledkov bude mať dostupné všetky študentove výsledky a stav prihlásení na jednotlivé úlohy.

Funkcionálne požiadavky

  1. Umožní vybrať používateľa systému
  2. Umožní editovať nastavenia
  3. Umožní kontrolovať štúdium študenta a jeho prihlasovanie sa na úlohy

Analýza stavu a systému

Opis a priorita

Administrátor bude mať možnosť vygenerovať náhľad registrovaných užívateľov. Bude kontrolovať priebeh vzdelávania a hodnotenia. Má prehľad o systéme, analyzuje jeho beh, stav a vývoj.

Priorita: vysoká

Odpoveď systému

Administrátor si bude môcť vybrať používateľa, ktorého bude kontrolovať/editovať. Pri editácii používateľa mu bude umožnené zmeniť jeho voľby. Pri kontrole výsledkov bude mať dostupné všetky študentove výsledky a stav prihlásení na jednotlivé úlohy. Administrátorovi sú dostupné štatistiky o systéme, jeho vyťažení, chybovosti a dostupnosti.

Funkcionálne požiadavky

  1. Umožní vybrať používateľa systému.
  2. Umožní kontrolovať štúdium študenta a jeho prihlasovanie sa na úlohy.
  3. Umožní sledovať stav systému prostredníctvom grafov a diagramov o jeho stave, vyťažení, chybovosti a dostupnosti.
  4. Umožní generovať reporty v štandardizovaných formátoch (.pdf alebo podobné) na predloženie vedeniu a ďalšiu analýzu.

Pridávanie uživateľov

Opis a priorita

Administrátor bude mať možnosť pridávať používateľov ako v Manažovanie študentov

Priorita: stredná

Odpoveď systému

Administrátor bude pridávať používateľov všetkých skupín, ako v Manažovanie študentov. Na požiadanie sa zobrazí formulár na pridávanie používateľov. Po odoslaní sa dáta uložia do databázy.

Funkcionálne požiadavky

  1. Umožní pridať používateľa systému

Správa entít

Opis a priorita

Administrátor bude mať možnosť vygenerovať náhľad registrovaných užívateľov. Tiež mu bude umožnené editovať nastavenia jednotlivých osobných účtov. Môže editovať všetky entity v systéme vrátane systémových nastavení, konštánt, užívateľov. Správa záloh systému a databázy.

Priorita: vysoká

Odpoveď systému

Administrátor si bude môcť vybrať používateľa, ktorého bude kontrolovať/editovať. Pri editácii používateľa mu bude umožnené zmeniť jeho voľby. Pri editácii systémových nastavení a konštánt mu bude umožnené dané hodnoty zobraziť a editovať. Bude mu užívateľským rozhraním umožnené zálohovať a obnovovať stav systému a databázy.

Funkcionálne požiadavky

  1. Umožní vybrať používateľa systému
  2. Umožní editovať nastavenia
  3. Umožní vybrať a editovať systémové hodnoty a konštanty
  4. Umožní vytvárať a obnovovať zálohy databázy a systému

Nefunkcionálne požiadavky

Požiadavky na výkon

Za bežných okolností bude systém používať naraz približne 300 ľudí. Systém ich musí vedieť obslúžiť s minimálnou latenciou. V kritických obdobiach (napr. koniec školského roka) môže systém naraz používať viac ako 1500 ľudí, vtedy čas odozvy musí byť menší ako 1 sekunda.

Bezpečnostné požiadavky

Užívatelia sa budú do systému prihlasovať prostredníctvom štandardizovaných identít (napr. ISIC) cez protokol HTTPS (alebo HTTP chránený iným aspoň 128bit šifrovaním). Povolené heslá budú musieť obsahovať aspoň 2 čísla, aspoň 2 znaky malej anglickej abeceny, aspoň 2 znaky veľkej anglickej abecedy a aspoň 2 špeciálne znaky. Heslá bude potrebné meniť aspoň raz mesačne a nebude možné opakovane použiť rovnaké heslá. Nesmú byť poskytnuté tretím stranám. Server môže byť fyzicky dostupný iba administrátorovi a vedeniu školy.

Dôvernosť systému

Systém musí spĺnať zákon č. 428/2002 Z. z. o ochrane osobných údajov. Akékoľvek údaje môže poskytnúť len povolanej osobe.

Prílohy

Use Case diagram

UseCase diagram e-BRAING

Personal tools