mirror of
https://github.com/jorenchik/mdemory.git
synced 2026-03-22 00:26:21 +00:00
docs: many small additions
This commit is contained in:
136
docs/main.typst
136
docs/main.typst
@@ -1296,17 +1296,26 @@ Process ir aprakstīts nākamā jautājuma noteikšanas aktivitātes diagrammā
|
|||||||
#pagebreak(weak: true)
|
#pagebreak(weak: true)
|
||||||
== Saskarnes projektējums
|
== Saskarnes projektējums
|
||||||
|
|
||||||
Kartīšu saraksta skats (skat. @fig:mdem-list-view) satur informāciju par
|
// TODO vai ir pēdējo mācīšanās laiku ar intervālu metodi
|
||||||
atmiņas kartīšu direktoriju un kartīšu faila saturu. Kartīšu informācija
|
|
||||||
iekļauj kartīšu faila direktorija nosaukumu, atmiņas kartīšu faila nosaukumu un
|
Lietotnes pamatā ir kartīšu saraksta skats (skat. @fig:mdem-list-view) satur
|
||||||
pēdējo faila mācīšanās laiku. Atmiņas bāzes faila saraksts rāda visus atmiņas
|
informāciju par atmiņas kartīšu direktoriju un kartīšu faila saturu. Kartīšu
|
||||||
kartītes failus un apakšdirektorijus ar atmiņas kartīšu failiem, kas tiek
|
informācija iekļauj kartīšu faila direktorija nosaukumu, apskatāmā atmiņas
|
||||||
izmantoti organizēšanai. Atmiņas kartīšu saraksts attēlo pagaidu atmiņas
|
kartīšu faila nosaukumu un tā pēdējo mācīšanās laiku. Atmiņas bāzes faila
|
||||||
kartīšu glabātuves sarakstu. Kartītes var pievienot un rediģēt, izmantojot
|
saraksts rāda visus atmiņas kartītes failus un apakšdirektorijus ar atmiņas
|
||||||
kartīšu redaktoru (skat. attēlu @fig:question-editor) un dzēst. Katīšu editorā
|
kartīšu failiem, kas tiek izmantoti organizēšanai. Atmiņas kartīšu saraksts
|
||||||
tiek uzģenerēts jautājuma pirmteksts, ko var izmainīt un saglabāt sarakstā
|
attēlo pagaidu atmiņas kartīšu glabātuves sarakstu. Katrai kartītei sarakstā
|
||||||
esošai kartītei. Kartītes pievienojot, redaktorā var ierakstīt vairākas
|
var apskatīties atbildi, to rediģēt vai dzēst.
|
||||||
kartītes vienlaicīgi. Katrai kartītei var apskatīties atbildi.
|
|
||||||
|
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
|
||||||
|
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
|
||||||
|
ierakstīt vienu vai vairākas kartītes vienlaicīgi. Redaktora poga "Saglabāt"
|
||||||
|
izsauc ievadītās kartītes(/-šu) transpilēšanu, rediģē vai pievieno
|
||||||
|
kartīti(/-tes), ja transpilēšana veiksmīga, un parāda kļūdu, ja transpilēšana
|
||||||
|
nav veiksmīga.
|
||||||
|
|
||||||
// TODO: all document teksts -> pirmteksts for questions
|
// TODO: all document teksts -> pirmteksts for questions
|
||||||
|
|
||||||
@@ -1323,11 +1332,11 @@ kartītes vienlaicīgi. Katrai kartītei var apskatīties atbildi.
|
|||||||
) <question-editor>
|
) <question-editor>
|
||||||
|
|
||||||
// Overall
|
// Overall
|
||||||
Katram jautājumam ir sava mācīšanās skata variācija. Katra variācija satur
|
Ja atrodoties faila sarakstā ar kartītēm, uzspiež pogu "Mācīties", parādās
|
||||||
jautājuma priekšas tesktu. Atkarībā no jautājuma ir pieejama pārbaudīšanas un
|
mācīšanās skats, kur tiek parādīti jautājumu skati pēc kārtas atbilstoši
|
||||||
atbildes parādīšanas funkcija.
|
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
|
||||||
// Interval
|
pieejama pārbaudīšanas un atbildes parādīšanas funkcija.
|
||||||
|
|
||||||
// Question type
|
// Question type
|
||||||
Atbildes jautājuma skatā ir paslēptas atbildes teksts ar vienu vai vairākiem
|
Atbildes jautājuma skatā ir paslēptas atbildes teksts ar vienu vai vairākiem
|
||||||
@@ -1364,24 +1373,24 @@ elementus pa grupām, pārbaudīt un parādīt pareizo atbildi.
|
|||||||
image("img/screens/group_question.png"),
|
image("img/screens/group_question.png"),
|
||||||
) <group-question-view>
|
) <group-question-view>
|
||||||
|
|
||||||
// TODO filler for
|
Ja tiek izmantots "Intervālu" mācišanās algoritms, tad pēc atbildes parādīšanas
|
||||||
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
|
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
|
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
|
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
|
uzspiests nepareizs intervāls, izvēli var pamainīt, uzspiežot uz citu intervāla
|
||||||
pogu.
|
pogu.
|
||||||
|
|
||||||
|
|
||||||
#figure(
|
#figure(
|
||||||
caption: "Intervāla izvēle",
|
caption: "Intervāla atbildes izvēle",
|
||||||
placement: auto,
|
placement: auto,
|
||||||
image("img/screens/interval_answer.png"),
|
image("img/screens/interval_answer.png"),
|
||||||
) <interval-answer>
|
) <interval-answer>
|
||||||
|
|
||||||
Konfigurācijas skats (skat. attēlu @fig:config-view) satur vairākus laikus
|
Konfigurācijas skats (skat. attēlu @fig:config-view) satur vairākus laukus
|
||||||
pieejamo lietotnes konfigurācijas parametru definēšanai. Lejā ir pieejamas
|
pieejamo lietotnes konfigurācijas parametru vērtību norādīšanai. Skata lejā ir
|
||||||
konfigurācijas ielādes un saglabāšanas funckijas.
|
pieejamas konfigurācijas ielādes un saglabāšanas funckijas. Spiežot uz pogu
|
||||||
|
"Saglabāt" konfigurācija tiek saglabāta konfigurācijas glabātuvē. Savukārt,
|
||||||
|
spiežot uz pogu "Ielādēt" konfigurācija tiek ielādeta konfigurācijas glabātuves.
|
||||||
|
|
||||||
#figure(
|
#figure(
|
||||||
caption: "Konfigurācijas skats",
|
caption: "Konfigurācijas skats",
|
||||||
@@ -1390,7 +1399,10 @@ konfigurācijas ielādes un saglabāšanas funckijas.
|
|||||||
) <config-view>
|
) <config-view>
|
||||||
|
|
||||||
Apmācības skats (skat. attēlu @fig:help-view) satur pamācību par lietotnes
|
Apmācības skats (skat. attēlu @fig:help-view) satur pamācību par lietotnes
|
||||||
informāciju. Apmācības skata saturs ir definēts ar statisku HTML dokumentu.
|
informāciju. Apmācības skata saturs ir definēts ar statisku HTML dokumentu, kas
|
||||||
|
tiek ielādēts ar kompilācijas. Dokuments satur aprakstu par lietotnes izmantošanu --
|
||||||
|
atmiņas kartīšanas definēšanu, kārtīšu pārvaldību, mācīšanos u.c.
|
||||||
|
// @Check: check if I said what is in the document corretly
|
||||||
|
|
||||||
#figure(
|
#figure(
|
||||||
caption: "Apmācības skats",
|
caption: "Apmācības skats",
|
||||||
@@ -1398,18 +1410,70 @@ informāciju. Apmācības skata saturs ir definēts ar statisku HTML dokumentu.
|
|||||||
image("img/screens/help.png"),
|
image("img/screens/help.png"),
|
||||||
) <help-view>
|
) <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)
|
#pagebreak(weak: true)
|
||||||
= Testēšanas dokumentācija
|
= Testēšanas dokumentācija
|
||||||
|
|
||||||
Lietotnes programmatūra ir notestēta, izmantojot automatizētus vienībtestus un
|
Lietotnes programmatūra ir testēta, izmantojot automatizētus vienību un
|
||||||
manuālus testus.
|
integrācijas testus un manuālus integrācijas testus. Funkcionālie testi ir
|
||||||
|
veikti, izmantojot melnās kastes tehnikas. Veiktais nefunkcionālais tests ir
|
||||||
|
automatizēts veiktspējas tests.
|
||||||
|
|
||||||
TODO
|
Automatizētie funkcionālie un nefunkcionālie testi ir veikti, izmantojot
|
||||||
|
bibliotēku "GTest". Testi ir darbināmi ar kompilācijas procesā izveidotu
|
||||||
|
izpildāmo failu. Izpildot testus konsolē tiek izvadīti testu rezultāti.
|
||||||
|
Rezultāti atspoguļo, vai testa failu definētās testa funkciju apgalbojumi
|
||||||
|
piepildās vai ne. Automatizēti testi ir iekļauti pamata pirmkoda repozitorijā
|
||||||
|
(skat. nodaļu #link(<sec:config-management>)["Konfigurācijas pārvaldība"]).
|
||||||
|
Automatizēti testi tiek izmantoti, testējot transpilatora moduļa funkcionalitātei.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
#testcase-table(
|
||||||
|
[
|
||||||
|
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.
|
||||||
|
],
|
||||||
|
[
|
||||||
|
Jautājuma fails, kur ir vairāki jautājumi ar dažādiem veidiem: atbildes
|
||||||
|
jautājums, izvēles jautājums, secības jautājums, grupēšanas jautājums.
|
||||||
|
],
|
||||||
|
[
|
||||||
|
Ievades fails tiek izvēlēts atmiņas bāzes sarakstā.
|
||||||
|
],
|
||||||
|
[
|
||||||
|
Visi jautājumi ir pareizi atspoguļoti sarakstā -- parādās to sākums un atbildes elementi.
|
||||||
|
],
|
||||||
|
[
|
||||||
|
OK
|
||||||
|
],
|
||||||
|
)<TG01>
|
||||||
|
|
||||||
|
// @Question: Cik testu dokumentācijas gadījumus jāiekļauj?
|
||||||
|
// @Improvement: Describe (introduce) what is "atmiņas bāze explicitly".
|
||||||
|
|
||||||
#pagebreak(weak: true)
|
#pagebreak(weak: true)
|
||||||
= Projekta organizācija
|
= Projekta organizācija
|
||||||
|
|
||||||
TODO
|
Projektu realizēja viens cilvēks.
|
||||||
|
|
||||||
#pagebreak(weak: true)
|
#pagebreak(weak: true)
|
||||||
= Kvalitātes nodrošināšana
|
= Kvalitātes nodrošināšana
|
||||||
@@ -1417,18 +1481,28 @@ TODO
|
|||||||
TODO
|
TODO
|
||||||
|
|
||||||
#pagebreak(weak: true)
|
#pagebreak(weak: true)
|
||||||
= Konfigurācijas pārvaldība
|
= Konfigurācijas pārvaldība<sec:config-management>
|
||||||
|
|
||||||
TODO
|
Pirmkods ir pārvaldīt, 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 ?
|
||||||
|
|
||||||
#pagebreak(weak: true)
|
#pagebreak(weak: true)
|
||||||
= Darbietiplības novērtējums
|
= Darbietiplības novērtējums
|
||||||
|
|
||||||
TODO
|
TODO Show CLOC screenshot
|
||||||
|
|
||||||
#pagebreak(weak: true)
|
#pagebreak(weak: true)
|
||||||
= Rezultāti
|
= Rezultāti
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
#pagebreak(weak: true)
|
#pagebreak(weak: true)
|
||||||
= Secinājumi
|
= Secinājumi
|
||||||
|
|
||||||
|
|||||||
@@ -63,26 +63,6 @@
|
|||||||
// linebreak()
|
// linebreak()
|
||||||
}
|
}
|
||||||
|
|
||||||
#let parameter-table(
|
|
||||||
caption: "",
|
|
||||||
..items,
|
|
||||||
) = {
|
|
||||||
if caption == "" {
|
|
||||||
caption = items.pos().first()
|
|
||||||
}
|
|
||||||
longtable(
|
|
||||||
titles: (
|
|
||||||
"Parametra nosaukums",
|
|
||||||
"Parametra identifikators",
|
|
||||||
"Parametra apraksts",
|
|
||||||
"Parametra prasības",
|
|
||||||
"Parametra piemērs (/-i)",
|
|
||||||
),
|
|
||||||
caption: caption,
|
|
||||||
..items,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
#let procedure-table(
|
#let procedure-table(
|
||||||
caption: "",
|
caption: "",
|
||||||
..items,
|
..items,
|
||||||
@@ -164,57 +144,30 @@
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
#let entity-table-row(
|
#let testcase-table(
|
||||||
..items,
|
|
||||||
) = {
|
|
||||||
(
|
|
||||||
items.pos().at(0),
|
|
||||||
upper(
|
|
||||||
raw(
|
|
||||||
items.pos().at(1),
|
|
||||||
block: false,
|
|
||||||
),
|
|
||||||
),
|
|
||||||
upper(
|
|
||||||
raw(
|
|
||||||
items.pos().at(2),
|
|
||||||
block: false,
|
|
||||||
),
|
|
||||||
),
|
|
||||||
items.pos().at(3),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
#let entity-table(
|
|
||||||
caption: "",
|
caption: "",
|
||||||
id: (),
|
|
||||||
..items,
|
..items,
|
||||||
) = {
|
) = {
|
||||||
if id == () {
|
if caption == "" {
|
||||||
id = (
|
caption = items.pos().first()
|
||||||
"id",
|
|
||||||
"serial8",
|
|
||||||
"primary key, not null",
|
|
||||||
"Unikālais identifikators",
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
longtable(
|
||||||
figure(
|
titles: (
|
||||||
caption: caption,
|
"Testa gadījuma nosaukums",
|
||||||
kind: table,
|
"Testa gadījuma identifikators",
|
||||||
tablex(
|
"Pirmsnosacījumi",
|
||||||
columns: (4cm, 3cm, auto, auto),
|
"Apraksts",
|
||||||
repeat-header: true,
|
"Ievade",
|
||||||
/* Header */
|
"Izpilde",
|
||||||
[*Lauks*], [*Datu tips*], [*Lauka atribūti*], [*Apraksts*],
|
"Sagaidāmais rezultāts",
|
||||||
|
"Rezultāts",
|
||||||
..entity-table-row(..id), // id row
|
|
||||||
|
|
||||||
..for i in range(items.pos().len(), step:4){
|
|
||||||
entity-table-row(..items.pos().slice(i, i+4))
|
|
||||||
},
|
|
||||||
),
|
),
|
||||||
|
caption: caption,
|
||||||
|
..items,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user