mirror of
https://github.com/jorenchik/mdemory.git
synced 2026-03-22 00:26:21 +00:00
docs: many small adjustments
This commit is contained in:
219
docs/main.typst
219
docs/main.typst
@@ -1296,7 +1296,7 @@ Process ir aprakstīts nākamā jautājuma noteikšanas aktivitātes diagrammā
|
||||
#pagebreak(weak: true)
|
||||
== Saskarnes projektējums
|
||||
|
||||
// TODO vai ir pēdējo mācīšanās laiku ar intervālu metodi
|
||||
// TODO vai LIETOTNĒ ir pēdējais mācīšanās laiku ar INTERFĀLU metodi
|
||||
|
||||
Lietotnes pamatā ir kartīšu saraksta skats (skat. @fig:mdem-list-view) satur
|
||||
informāciju par atmiņas kartīšu direktoriju un kartīšu faila saturu. Kartīšu
|
||||
@@ -1307,8 +1307,27 @@ kartīšu failiem, kas tiek izmantoti organizēšanai. Atmiņas kartīšu saraks
|
||||
attēlo pagaidu atmiņas kartīšu glabātuves sarakstu. Katrai kartītei sarakstā
|
||||
var apskatīties atbildi, to rediģēt vai dzēst.
|
||||
|
||||
Konfigurācijas skats (skat. attēlu @fig:config-view), redaktora skats (skat
|
||||
attēlu @fig:editor-view), un apmācības skats (skat. attēlu @fig:help-view) un
|
||||
jautājumu skati (skat. attēlus
|
||||
@fig:answer-question-view\-@fig:group-question-view) ir logi, kas ir atverami
|
||||
no atmiņas kartīšu skata. Jautājumu skats tiek pārveidots uz citu jautājuma
|
||||
veida skatu viena loga ietvaros. Katra skata logs var būt tikai vienā
|
||||
eksemplārā, i.e., var tikt atvērts tikai viens katra veida logs vienas
|
||||
lietotnes instances ietvaros. Ekrānskatu plūsma ir attēlota ekrānskatu plūsmas
|
||||
diagrammā.
|
||||
|
||||
//lietotnes TODO termin instance
|
||||
|
||||
#figure(
|
||||
caption: "Ekrānskatu plūsmas diagramma",
|
||||
placement: auto,
|
||||
image("img/view_flow_diagram.svg"),
|
||||
) <view-flow-diagram>
|
||||
|
||||
|
||||
Kartītes var pievienot un rediģēt, izmantojot kartīšu redaktoru (skat. attēlu
|
||||
@fig:question-editor). Kartīšu redaktors ir logs, kas tiek parādīts, uzpiežot
|
||||
@fig:editor-view). Kartīšu redaktors ir logs, kas tiek parādīts, uzpiežot
|
||||
uz "Pievienot" vai "Rediģēt", kur var ievadīt tekstu. Ja kartīte tiek rediģēta,
|
||||
tajā tiek uzģenerēts jautājuma pirmteksts, ko var izmainīt un saglabāt sarakstā
|
||||
esošai kartītei. Ja kartīti(/-es) pievieno, redaktors ir tukšs un tajā var
|
||||
@@ -1329,14 +1348,15 @@ nav veiksmīga.
|
||||
caption: "Kartīšu redaktora skats",
|
||||
placement: auto,
|
||||
image("img/screens/question_editor.png"),
|
||||
) <question-editor>
|
||||
) <editor-view>
|
||||
|
||||
// Overall
|
||||
Ja atrodoties faila sarakstā ar kartītēm, uzspiež pogu "Mācīties", parādās
|
||||
mācīšanās skats, kur tiek parādīti jautājumu skati pēc kārtas atbilstoši
|
||||
mācīšanās algoritmam. Katram jautājumam ir sava mācīšanās skata variācija.
|
||||
Katra variācija satur jautājuma priekšas tesktu. Atkarībā no jautājuma ir
|
||||
pieejama pārbaudīšanas un atbildes parādīšanas funkcija.
|
||||
viens no jautājumu skatiem. Jautājumu skati tiek rādīti pēc kārtas spiežot pogu
|
||||
"Nākamais", atbilstoši mācīšanās algoritmam. Katram jautājumam ir sava
|
||||
mācīšanās skata variācija. Katra variācija satur jautājuma priekšas tesktu.
|
||||
Atkarībā no jautājuma ir pieejama pārbaudīšanas un atbildes parādīšanas
|
||||
funkcija.
|
||||
|
||||
// Question type
|
||||
Atbildes jautājuma skatā ir paslēptas atbildes teksts ar vienu vai vairākiem
|
||||
@@ -1376,9 +1396,12 @@ elementus pa grupām, pārbaudīt un parādīt pareizo atbildi.
|
||||
Ja tiek izmantots "Intervālu" mācišanās algoritms, tad pēc atbildes parādīšanas
|
||||
un pārbaudes, ja tāda ir, tiek parādīta izvēle ar intervāliem, ko izvēloties
|
||||
jautājumiem tiek pievienots pārtraukums atbilstoši konfigurācijā uzstādītu
|
||||
vērtību. Ja pārtraukums nav vajadzīgs, intervālu var neizvēlēties. Ja tika
|
||||
uzspiests nepareizs intervāls, izvēli var pamainīt, uzspiežot uz citu intervāla
|
||||
pogu.
|
||||
vērtību (skat. attēlu @fig:interval-answer). Ja pārtraukums nav vajadzīgs,
|
||||
intervālu var neizvēlēties. Ja tika uzspiests nepareizs intervāls, izvēli var
|
||||
pamainīt, uzspiežot uz citu intervāla pogu. Mācīšanas laiks un intervālu
|
||||
atbildes tiek piefiksētas sesijas laikā pagaidu glabātuvē. Lai mācīšanās laiks
|
||||
un pārtraukumi pēc norādītām atbildēm ir saglabāti pēc lietotāja pieprasījuma
|
||||
spiežot uz "Saglabāt progresu".
|
||||
|
||||
#figure(
|
||||
caption: "Intervāla atbildes izvēle",
|
||||
@@ -1410,16 +1433,11 @@ atmiņas kartīšanas definēšanu, kārtīšu pārvaldību, mācīšanos u.c.
|
||||
image("img/screens/help.png"),
|
||||
) <help-view>
|
||||
|
||||
/*
|
||||
== Tehniskā realizācija
|
||||
|
||||
Risinājums ir izstrādāts, izmantojot valodu "C++", tās standarta bibliotēku,
|
||||
vairākas bibliotēkas un uzbūvēšanas sistēmu "CMake".
|
||||
*/
|
||||
|
||||
#pagebreak(weak: true)
|
||||
= Testēšanas dokumentācija
|
||||
|
||||
== Testēšanas apraksts
|
||||
|
||||
Lietotnes programmatūra ir testēta, izmantojot automatizētus vienību un
|
||||
integrācijas testus un manuālus integrācijas testus. Funkcionālie testi ir
|
||||
veikti, izmantojot melnās kastes tehnikas. Veiktais nefunkcionālais tests ir
|
||||
@@ -1437,18 +1455,32 @@ Manuālie integrācijas testi tiek veikti, izmantojot lietotāju saskarni. Testi
|
||||
ir dokumentēti tabulās norādot testa gadījuma nosaukumu, pirmsnosacījumus,
|
||||
aprakstu, ievadi, izpildi, sagaidāmo rezultātu un rezultātu ("OK" -- rezultāts
|
||||
atbilst sagaidāmam, "NOK" -- rezultāts neatbilst sagaidāmam). Daļa no testa
|
||||
gadījumiem ir aprakstīti tabulās @tbl:TG01\-TODO.
|
||||
gadījumiem ir aprakstīti tabulās @tbl:TG01\-TODO. Pamata testēšanas gadījumu
|
||||
dokumentācija ir veidota izklājlapā.
|
||||
|
||||
== Manuālā testēšana
|
||||
|
||||
/*
|
||||
#testcase-table(
|
||||
"",
|
||||
"TG00",
|
||||
"",
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
"",
|
||||
)<TG00>
|
||||
*/
|
||||
|
||||
#testcase-table(
|
||||
[
|
||||
Dažāda veida jautājumu apstrāde
|
||||
],
|
||||
[
|
||||
TG01
|
||||
],
|
||||
[
|
||||
Ir atvērta atmiņas bāze, ar testējamiem failiem.
|
||||
],
|
||||
"Dažāda veida jautājumu apstrāde",
|
||||
"TG01",
|
||||
"Ir atvērta atmiņas bāze, ar testējamiem failiem.",
|
||||
[
|
||||
Tests pārbauda vai tiek ielādēts fails ar dažādiem jautājumu veidiem.
|
||||
],
|
||||
@@ -1462,51 +1494,144 @@ gadījumiem ir aprakstīti tabulās @tbl:TG01\-TODO.
|
||||
[
|
||||
Visi jautājumi ir pareizi atspoguļoti sarakstā -- parādās to sākums un atbildes elementi.
|
||||
],
|
||||
[
|
||||
OK
|
||||
],
|
||||
"",
|
||||
)<TG01>
|
||||
|
||||
|
||||
#testcase-table(
|
||||
"Transpilācijas kļūda parāda paziņojumu par kļūdu",
|
||||
"TG02",
|
||||
"",
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
"",
|
||||
)<TG02>
|
||||
|
||||
#testcase-table(
|
||||
"Jautājums tiek izdzēst tikai pagaidu glabātuvē",
|
||||
"TG03",
|
||||
"",
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
"",
|
||||
)<TG03>
|
||||
|
||||
#testcase-table(
|
||||
"Tiek pievienots viens jautājums",
|
||||
"TG04",
|
||||
"",
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
"",
|
||||
)<TG04>
|
||||
|
||||
#testcase-table(
|
||||
"Tiek pievienoti vairāki dažādu veidu jautājumi",
|
||||
"TG05",
|
||||
"",
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
"",
|
||||
)<TG05>
|
||||
|
||||
#testcase-table(
|
||||
"Tiek pievienoti vairāki dažādu veidu jautājumi",
|
||||
"TG06",
|
||||
"",
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
[
|
||||
],
|
||||
"",
|
||||
)<TG06>
|
||||
|
||||
// @Question: Cik testu dokumentācijas gadījumus jāiekļauj?
|
||||
// @Improvement: Describe (introduce) what is "atmiņas bāze explicitly".
|
||||
|
||||
#pagebreak(weak: true)
|
||||
= Projekta organizācija
|
||||
|
||||
Projektu realizēja viens cilvēks.
|
||||
== Projekta organizācijas apraksts
|
||||
|
||||
Kvalifikācijas darba prasības nosaka, ka programmatūras produktu un
|
||||
dokumentāciju izstrādā darba autors patstāvīgi. Projektam ir noteikts un
|
||||
stingrs termiņš. Patstāvīga projekta veidošana atvieglo organizāciju, jo darbs
|
||||
ir jāorganizē tikai vienam cilvēkam un nevar rasties komunikācijas problēmas.
|
||||
Datu specifikācijas savākšana ir atvieglota, jo pasūtītājs šī darba ietvaros ir
|
||||
darba autors.
|
||||
|
||||
Programmatūras un dokumentācijas izstrāde bija veikta iteratīvi, pielietojot
|
||||
spējo metodi. Izstrādes gaita tika sadalīta aptuvenās fāzēs: prototipēšana,
|
||||
specifikācija izstrāde un testēšana. Fāzes aktivitātes nav ierobežotas tikai uz fāzei
|
||||
atbilstošām aktivitātēm. Dokumentācijas veidošana bija veikta katras fāzes
|
||||
ietvaros.
|
||||
|
||||
== Prototipēšanas fāze
|
||||
|
||||
== Specifikācijas un izstrādes fāze
|
||||
|
||||
== Testēšanas fāze
|
||||
|
||||
/*
|
||||
# Questions
|
||||
- Ko var pielikt saistībā ar programmatūras izstrādi -- bibliotēkas etc?;
|
||||
*/
|
||||
|
||||
#pagebreak(weak: true)
|
||||
= Kvalitātes nodrošināšana
|
||||
|
||||
TODO
|
||||
|
||||
#pagebreak(weak: true)
|
||||
= Konfigurācijas pārvaldība<sec:config-management>
|
||||
|
||||
Pirmkods ir pārvaldīt, izmantojot konfigurācijas pārvaldības sistēmu "git".
|
||||
Pirmkods ir pārvaldīts, izmantojot konfigurācijas pārvaldības sistēmu "git".
|
||||
Pirmkoda repozitorijs, saturot vienu zaru "main" vienkāršumam. Repozitorijs ir
|
||||
mitināts, izmantojot "GitHub" platformu, kas ir nokonfigurēts kā privāts.
|
||||
|
||||
Repozitorijā ir iekļauta dokumentācija programmatūras pirmkods un tās
|
||||
konfigurācijas faili.
|
||||
|
||||
TODO explain
|
||||
TODO CMake ?
|
||||
mitināts, izmantojot "GitHub" platformu. Repozitorijā ir iekļauta dokumentācija
|
||||
programmatūras pirmkods un tās konfigurācijas faili un uzbūvēšanas sistēmas
|
||||
"CMake faili".
|
||||
|
||||
#pagebreak(weak: true)
|
||||
= Darbietiplības novērtējums
|
||||
|
||||
TODO Show CLOC screenshot
|
||||
Tā kā programmatūras produkts ir izstrādāts, darbietilpību novertēt, izmantojot
|
||||
loģiskās koda rindiņu skaitu projektā.
|
||||
|
||||
#pagebreak(weak: true)
|
||||
= Rezultāti
|
||||
|
||||
TODO
|
||||
#figure(
|
||||
caption: "CLOC rīka rezultāts",
|
||||
placement: auto,
|
||||
image("img/screens/cloc.png"),
|
||||
) <cloc-view>
|
||||
|
||||
#pagebreak(weak: true)
|
||||
= Secinājumi
|
||||
|
||||
TODO
|
||||
|
||||
#pagebreak(weak: true)
|
||||
#heading(numbering: none, "Izmantotā literatūra un avoti")
|
||||
|
||||
Reference in New Issue
Block a user