docs: design and resolved some TOSOs

This commit is contained in:
jorenchik
2024-11-04 21:57:21 +02:00
parent 0bb2a265f9
commit 96fd6a8ec0
3 changed files with 80 additions and 26 deletions

View File

@@ -51,10 +51,13 @@
*CSV* -- formāts, kas satur vērtības, kas ir atdalīti ar komatiem;
*Parsēšana* -- TODO;
*Parsēšana* -- tekstvienību pārveidošana dažāda objektos;
*Buferis* -- TODO;
*Buferis* -- saraksts ar kāda tipa vērtībām, kas tiek tiek piepildināts un
atbrīvots kāda procesa ietvaros;
*HTML (angl. HyperText Markup Language)* -- hiperteksta iezīmēšanas valoda,
ko izmantojot, ir uzbūvēta lielākā daļa no tīmekļa mājaslapu;
],
)
@@ -212,7 +215,6 @@ slēptā formātā, kas apgrūtina kartīšu pārvaldību un pārnešanu.
== Risinājuma lietotāji
// TODO Spelling
#indent-par([
Risinājumam ir viena lietotāju grupa, kam ir pieejamas visas risinājuma
iespējas un funkcijas.
@@ -274,11 +276,12 @@ vērtību diapazonā.
#pagebreak(weak: true)
= Programmatūras prasību specifikācija
// Šajā sadaļā tiks aprakstīts TODO??
Šajā sadaļā tiks aprakstīts datu glabāšanas konceptuālais modelis, funkcionālās
prasības, kas iekļauj lietotnes datu plūsmas diagrammas, funckiju, datu formātu
un datu struktūru definīcijas un lietotnes nefunkcionālās prasības.
== Konceptuālais entitāšu-relāciju modelis
// TODO spelling
Risinājuma glabātie dati iekļauj atmiņas kartīšu un konfigurācijas datus, kas
tiek glabāti vienkāršos failos. Risinājums neizmantos datubāzi datu glabāšanai.
Risinājumā entitātes ir attēlotas konceptuālā entitāšu-relāciju modelī (skat. attēlu
@@ -297,12 +300,11 @@ Modelī ir iekļauti metadati, kā pēdējās mācīšanās laiks, jautājuma p
laiks un faila nosaukums. Pēdējās mācīšanās laiks tiek izmantots intervālu
metodē, lai reģistrētu laiku un pielietot intervālu metodi turpmākās mācību
reizēs. Jautājuma pārtraukuma laiks nosaka, cik ilgam laikam jāpaiet, lai
jautājums atkal būtu iekļauts intervālu metodes mācīšanās.
Faila nosaukums tiek izmantots kā kartīšu saraksta nosaukums -- to var izmanot,
lai nosauktu failā esošās kartītes, piemēram, to tēmu vai nolūku.
Papildus datetime TODO
jautājums atkal būtu iekļauts intervālu metodes mācīšanās. Faila nosaukums tiek
izmantots kā kartīšu saraksta nosaukums -- to var izmanot, lai nosauktu failā
esošās kartītes, piemēram, to tēmu vai nolūku. Fails var saturēt pēdējās
mācīšanās datumu un laiku, kas tiek izmantota vienā no mācīšanās algoritmiem,
ko izmanto lietotne.
#figure(
caption: "Konceptuālais entitāšu-relāciju modelis",
@@ -477,7 +479,7 @@ Papildus datetime TODO
]
)<DF05>
// @TODO: replace every jautājums -> kartīte except where its really needed.
// TODO: replace every jautājums -> kartīte except where its really needed.
#format-table(
"Kartītes faila pirmteksts",
@@ -553,8 +555,6 @@ Papildus datetime TODO
[
Lappuse ir ir saraksts ar referencēm uz vairākiem jautājuma objektiem, kam ir
noteikts lappuses skaitlis.
// TODO: elaborate more
],
)<DS02>
@@ -810,7 +810,7 @@ Papildus datetime TODO
) <AB03>
// @TODO: for all things that save someth somewhere, say that in the Izvade
// TODO: for all things that save someth somewhere, say that in the Izvade
#function-table(
"Kartīšu pievienošana",
@@ -1370,8 +1370,12 @@ pēdējo faila mācīšanās laiku. Atmiņas bāzes faila saraksts rāda visus a
kartītes failus un apakšdirektorijus ar atmiņas kartīšu failiem, kas tiek
izmantoti organizēšanai. Atmiņas kartīšu saraksts attēlo pagaidu atmiņas
kartīšu glabātuves sarakstu. Kartītes var pievienot un rediģēt, izmantojot
kartīšu redaktoru (skat. TODO) un dzēst. Katrai kartītei var apskatīties
atbildi.
kartīšu redaktoru (skat. attēlu @fig:question-editor) un dzēst. Katīšu editorā
tiek uzģenerēts jautājuma pirmteksts, ko var izmainīt un saglabāt sarakstā
esošai kartītei. Kartītes pievienojot, redaktorā var ierakstīt vairākas
kartītes vienlaicīgi. Katrai kartītei var apskatīties atbildi.
// TODO: all document teksts -> pirmteksts for questions
#figure(
caption: "Kartīšu saraksta skats",
@@ -1379,13 +1383,11 @@ atbildi.
image("img/screens/mdem_list.png"),
) <mdem-list-view>
/*
TODO
#figure(
caption: "Atbildes redaktora skats",
caption: "Kartīšu redaktora skats",
placement: auto,
image("img/screens/answer_question.png"),
) <answer-question-view> */
image("img/screens/question_editor.png"),
) <question-editor>
// Overall
Katram jautājumam ir sava mācīšanās skata variācija. Katra variācija satur
@@ -1429,12 +1431,34 @@ elementus pa grupām, pārbaudīt un parādīt pareizo atbildi.
image("img/screens/group_question.png"),
) <group-question-view>
// TODO filler for
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.
#figure(
caption: "Intervāla izvēle",
placement: auto,
image("img/screens/interval_answer.png"),
) <interval-answer>
Konfigurācijas skats (skat. attēlu @fig:config-view) satur vairākus laikus
pieejamo lietotnes konfigurācijas parametru definēšanai. Lejā ir pieejamas
konfigurācijas ielādes un saglabāšanas funckijas.
#figure(
caption: "Konfigurācijas skats",
placement: auto,
image("img/screens/config.png"),
) <config-view>
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.
#figure(
caption: "Apmācības skats",
placement: auto,
@@ -1444,27 +1468,45 @@ elementus pa grupām, pārbaudīt un parādīt pareizo atbildi.
#pagebreak(weak: true)
= Testēšanas dokumentācija
Lietotnes programmatūra ir notestēta, izmantojot automatizētus vienībtestus un
manuālus testus.
TODO
#pagebreak(weak: true)
= Projekta organizācija
TODO
#pagebreak(weak: true)
= Kvalitātes nodrošināšana
TODO
#pagebreak(weak: true)
= Konfigurācijas pārvaldība
TODO
#pagebreak(weak: true)
= Darbietiplības novērtējums
TODO
#pagebreak(weak: true)
= Rezultāti
#pagebreak(weak: true)
= Secinājumi
TODO
#pagebreak(weak: true)
#heading(numbering: none, "Izmantotā literatūra un avoti")
+ #hyperlink-source(
"Alison Voice and Arran Stirton",
[Spaced Repetition: towards more effective learning in STEM (2020)],
[Spaced Repetition: towards more effective learning in STEM, 2020. TODO],
"https://web.archive.org/web/20171019211402/https://www.loc.gov/standards/datetime/ISO_DIS%208601-1.pdf",
std.datetime(
year: 2024,
@@ -1510,14 +1552,22 @@ elementus pa grupām, pārbaudīt un parādīt pareizo atbildi.
),
)<quizlet>
+ #hyperlink-source(
"OMG (Object Management Group)",
[Unified Modeling Language (v2.5). 2015. jūnijs],
"https://www.omg.org/spec/UML/2.5/PDF",
std.datetime(
year: 2024,
month: 11,
day: 04,
),
)<uml-2.5-spec>
+ TODO UML 2.5. spec
#pagebreak(weak: true)
#heading(numbering: none, "Pielikumi")
// TODO caption
```cpp
std::vector<Token> tokens;
std::vector<char> buffer;
@@ -2170,3 +2220,7 @@ std::string GroupQuestion::toString() const {
);
}
```
#pagebreak(weak: true)
#heading(numbering: none, "Dokumentārā lapa")