2024∕25 PROJEKT nr 4 ‐ Lõputööde dokumenteerimine - kuressaareametikool/tarkvaraprojektid GitHub Wiki

Ülevaade

Projekti eesmärk on toetada lõputööde dokumentatsiooni koostamist, kasutades Atassiani tööriistu Jira & Confluence.
Projektis osalevad meeskonnad, mis koosnevad kursuste õpilastest. Järgmisel kevadel lõpetavatest kursuste TAK-23 ja TA-24, kes läbisid neid tööriistu tutvustava töötoa, kelle roll on olla tööriistade kasutamisega kursis ja olla juhendaja rollis. Lõpukursused TAK-22 ja TA-23, kellel on lõputöö idee.

Tiimid

Dokumenenteerimisnõuded

  1. Tööde jaotamine ja jälgimine Jira-s

    • Piletite liikumine staatustes: Kõik piletid liiguvad järjekindlalt ühest staatusest teise (nt To Do, In Progress, In Review, Done).
    • Iga staadium peab olema täidetud enne järgmisse liikumist, tagades, et iga tegevus on lõpetatud enne, kui see edasi liigub.
    • Igas piletis on kirjas tööülesanne koos eesmärkidega. Lisaks võib piletis kirjas olla nõuded testimisele.
    • Ülesanded peavad olema määratletud nii, et neid saab lõpptulemuse põhjal kontrollida.
    • Prioriteedi määramine: Kõik piletitel on määratud prioriteet (nt Low, Medium, High), et meeskond saaks täpselt jälgida, mis on kõige tähtsam.
    • Kõikidel piletitel on määratud konkreetne tegija või tegijad, et tagada vastutus iga ülesande eest.

  2. Spetsiifilised piletitüübid ja lisafunktsionaalsused

    • Projektispetsiifiline piletitüüp: Loo vähemalt üks projektiga seotud eriline piletitüüp, näiteks "Dokumentatsioon", mille eesmärgiks on projektidokumentatsiooni loomine ja täiendamine. Sellel piletitüübil on eraldi täitmise nõuded, nagu dokumentide koostamine, ülevaatamine ja uuendamine.
    • Iga arendus- ja ülesandepilet peab sisaldama testimisnõudeid, et arendatud funktsionaalsus oleks kontrollitud ja testitud enne lõpptulemuse valmimist.

  3. Töötegevuste jälgimine ja dokumentatsioon

    • Projekti edenemise kohta toimub vähemalt üks iganädalane koosolek, mille protokoll on dokumenteeritud Confluence'is. Koosolekute eesmärk on arutada tehtud töid, järgmisi samme ja probleemide lahendamist.
    • Iga meeskond peab looma lühikese materjali, kus tutvustatakse, mis projekti eesmärk ja tulemid on.
    • Iga funktsionaalsuse jaoks tuleb luua testimisjuhendid, mis on dokumenteeritud Confluence'is ja lingitud Jira piletitega.

  4. Vigade jälgimine ja lahendamine

    • Kõik projekti käigus tekkivad vead peavad olema dokumenteeritud Bug tüüpi piletites.
    • Iga bug-tüüpi pilet peab sisaldama põhjalikku kirjeldust, võimaliku põhjuse analüüsi ja plaani vea parandamiseks.
    • Iga viga, mis on lahendatud, peab olema seotud arendustegevusega, kus tuleb teha täiendavaid muudatusi või parandusi. Iga bugi peab sisaldama ka täiendavat testimist, et tagada selle lahenduse toimimine.

  5. Koostöö ja kommunikatsioon

    • Kommentaaride ja ülesannete ajalugu: Kõik meeskonnaliikmete vahelised arutelud ja muudatused peavad olema dokumenteeritud Jira piletites läbi kommentaaride.
    • Linkimine Jira ja Confluence vahel: Jira piletid peaksid olema vajadusel seotud Confluence'i lehtedega (nt planeeritud lahenduse, testimisjuhendite või kohtumiste protokollide linkimine), et kõik vajalikud dokumendid oleksid kergesti ligipääsetavad.

  6. Projektipõhised hindamisnõuded

    • Iga Epic peaks sisaldama vähemalt 2-3 Taski, millel on alampiletid (Sub-taskid) ja kus on määratud selged eesmärgid.
    • Regulaarsed ülevaatused ja analüüs: Projekti jooksul peab olema vähemalt üks põhjalik ülevaatus, kus analüüsitakse projekti edenemist, plaani täitmist ja vajadusel tehakse muudatusi.

Nõuete lühendatud nimekiri

  • Projektil on Jira board ja Confluence tööruum.
  • Jira boardil on vähemalt 3-5 Epic tüüpi piletit.
  • Igal Epic tüüpi piletil on vähemalt kaks alamülesannet (näiteks task või bug tüüpi).
  • Kõik piletid liiguvad järjekindlalt ühest staatusest teise (nt To Do, In Progress, In Review, Done).
  • Igas piletis on kirjas tööülesanne koos eesmärkidega.
  • Kõikidel piletitel on määratud prioriteedi väli (Priority) ja prioriteet (nt Low, Medium, High).
  • Kõikidel piletitel on määratud tegija (Assignee).
  • Loodud on vähemalt üks projektispetsiifiline piletitüüp (nt "Dokumentatsioon" või "Analüüs").
  • Iga arendus- ja ülesandepilet sisaldab testimisnõudeid ja testimise tulemusi. Nt sammud, mida pileti valmimise tulemusena kindlasti testida tuleks.
  • Regulaarsete koosolekute protokollid on dokumenteeritud Confluence'is.
  • Meeskond on loonud lühikese materjali (Confluence leht), kus tutvustatakse projekti eesmärki ja tulemusi.
  • Kõik vead on dokumenteeritud Bug tüüpi piletites.
  • Igas bug-piletis on põhjalik kirjeldus, analüüs ja plaan vea parandamiseks.
  • Kõik meeskonnaliikmete vahelised arutelud on dokumenteeritud Jira kommentaarides.
  • Confluence struktuur on loogiline ja vajalik info on kergesti leitav.
  • Projekti eesmärgiks on õppida tarkvaraprojekti dokumeenteerima kasutades selleks Atassiani tööriistu Jira & Confluence.
  • Jira piletid on vajadusel seotud Confluence'i lehtedega (nt testimisjuhendid, kohtumiste protokollid).
  • Projekti jooksul on vähemalt üks põhjalik ülevaatus, kus analüüsitakse projekti edenemist ja tehakse muudatusi.