docs in progress

docs/main.typst

@@ -22,6 +22,8 @@
   first-line-indent: 0cm,
   [
     / API: lietojumprogrammu saskarne (angl. Application Program Interface);
+    / Markdown: TODO;
+    / Atzīmēšanas valoda: TODO;
   ],
 )
 
@@ -40,6 +42,19 @@
 
 == Darbības sfēra 
 
+// 1) identificēt programmatūras produkta nosaukumu, piemēram, "Pārskatu ģenerators", utt.,
+// 2) paskaidrot kas programmatūras produktam jādara un, ja nepieciešams, kas
+// nav jādara;
+// 3) aprakstīt programmatūras produkta pielietojumu.
+// a) Aprakstīt, cik iespējams precīzi, iespējas, centienus un mērķi. Piemēram,
+// teikums: iespēja efektīvi izstrādāt pārskatus nav tik labs, kā parametrizēti,
+// lietotāja vadīti un definēti pārskati divu stundu laikā, ar iespēju ievadīt
+// lietotāja parametrus dialoga režīmā.
+// b) Nepieļaut pretrunas, lietojot terminus, kas līdzīgi terminiem augstāka
+// līmeņa LVS 68:1996 lpp. 15. (22) specifikācijā (piemēram, Sistēmprasību
+
+
+// Kas ir atmiņas kartes
 #indent-par([
 	Atmiņas kartītes (Angl. flashcards) ir izplatīts veids, kā skolēni, studenti un
 	citi macošies cilvēki iegaumē materiālu. Šādu kartīšu pamatā parasti ir priekša
@@ -49,21 +64,124 @@
 	atbildi uz priekšā uzstādītu jautājumu vai uzdevumu.
 ])
 
-Tiek veidotas vairākas atmiņas kartītes uz līdzīgu tēmu, veidojas kartīšu kaudzes.
-Mācīšanas seansā, tiek vērtēts, cik grūti vai viegli jautājumi vai uzdevumi ir 
-atbildāmi vai atrisināmi attiecīgi. Balstoties uz grūtību vai iespēju atbildēt, 
-kartītes tiek grupētas noteiktās grupās, kas, savukārt, nosaka intervālu, pēc kura
-kartīte figurēs nākamā mācīšanās seansā. Piemēram, grupas - ļoti viegli, vidēji,
-grūti, neizdevās -, kam atbilst 5 dienas, 3 dienas, 1 diena, 0 dienas attiecīgi.
-Jo lielāka ir subjektīva piepūle, atbildējot uz jautājumu vai risinot uzdevumu,
-jo TK.
+// Mācīšanās process un spaced-repetition 
+Mācīšanās nolūkiem tiek veidotas vairākas atmiņas kartītes uz līdzīgu tēmu,
+veidojas kartīšu kaudzes. Mācīšanas seansā, tiek vērtēts, cik grūti vai viegli
+jautājumi vai uzdevumi ir attiecīgi atbildāmi vai atrisināmi. Balstoties uz
+grūtību vai iespēju atbildēt, kartītes tiek grupētas noteiktās grupās, kas,
+savukārt, nosaka intervālu, pēc kura kartīte figurēs nākamā mācīšanās seansā.
+Piemēram, grupas - ļoti viegli, vidēji, grūti, neizdevās -, kam atbilst 5
+dienas, 3 dienas, 1 diena, 0 dienas attiecīgi. Jo lielāka ir subjektīva
+piepūle, atbildot uz jautājumu vai risinot uzdevumu, jo tiek uzturēts garāks
+pārtraukums pirms nākamās reizes, kad šī kartīte būs izmantota. Šī mācīšanās 
+metode ir atkārtošana ar intervāliem.
+// TODO: reference
 
-Veidojot atmiņas kartītes manuāli, var rasties grūtības, kā nozaudēšana, 
-kļūdas sagatavojot tekstu, mācīšanās algoritma uzstādīšanas sarežģītība.
+// Stuff mdemory does
+Veidojot atmiņas kartītes manuāli tās var pazaudēt, var kļūdīties, sagatavojot
+to tekstu. Tāpēc ir iespējams kartītes veidot un uzturēt, izmantojot tīmekļa
+vai lokālo lietotni. Aprakstāmās programmatūras mērķis ir vienkāršot atmiņas
+kartīšu veidošanu ar iespēju veidot, mainīt un glabāt atmiņas kartītes
+vienkāršā tekstā un mācīies izmantojot atkārtošanu ar intervāliem. Atmiņas
+kartītītes ir glabātas teksta failos un glabājas direktorijā, kas pilnībā
+paliek lietotāja pārvaldē. Vienkārša teksta kartīšu glabāšana paredz, ka
+lietotājs var brīvi pārvietot un mainīt kartīšu saturu, turpinot izmantot
+programmatūras mācīšanās funkcionalitāti. 
+
+Uzsvars ir uz pilnīgu atmiņas kartīšanu glabāšanas pilnīgu caurspīdīgumu -
+kartītes glabājas bez slēptas informācijas. Vienkārša teksta izmantošana bez
+slēptas informācijas atbrīvo lietotāju no atkarības no šīs programmatūras ar
+iespēju pārslēgties uz citu risinājumu ar dažām teksta izmaiņām.
+
+// TODO: import / manage all questions
+
+// The name
+Programmatūras produkta nosaukums ir "Mdemory", kas ir darināts nosaukums no
+"MD" (atzīmēšanas valodas Markdown abreviatūra) un "memory" (angl. atmiņa), kas
+parāda produkta saistību ar atmiņu.
+
+== Saistība ar citiem dokumentiem
+
+
+== Pārskats
+
+// apraksts: Ievads
+
+Ievadā tiek aprakstīta galvenā programmatūras produkta būtība.
+// TODO
+
+// apraksts: Vispārējs apraksts
+// TODO
+
+// apraksts: Programmatūras prasību specifikācija
+// TODO
+
+// apraksts: Programmatūras projektējuma apraksts
+// TODO
 
 #pagebreak(weak: true)
 #set heading(numbering: "1.1.")
-
 = Vispārējais apraksts
 
+== Esošā stāvokļa apraksts
+
+Esošie atmiņas kartīšu risinājumi galvenokārt atbalsta atmiņas 
+kartīšu importu ar vienkāršu tekstu. Taču lielākā daļa nedod iespēju
+uzturēt kartītes bez vienkāršā tekstā, jo risinājumi glabā kartītes
+savā, pielāgotā formātā. 
+
+Daži risinājumi iekļauj arī vairākus specializētus jautājumu veidus, kā grupēšanas 
+jautājumi, vairāku atbilžu jautājumus un secības jautājumus. Tādu risinājumu piemērs ir 
+"Quizlet" lietotne. Minētā importa funkcija parasti nav pieejama esošos risinājumos.
+To importa funkcionalitāte realizē vienkāršu importu visbiežāk ar mērķi migrēt atmiņas kartītes
+vienas lietotnes ietvaros. 
+
+// org-drill
+Diezgan tuvs pēc funckionalitātes mērķiem ir "Emacs" teksta editora
+papildinājums "org-drill". Tas piedāvā vienkārša teksta atmiņas kartīšu veidošanu 
+un glabāšanu ar vienkāršu tekstu ar augstu pielāgojamību. Toties tas pieprasa
+"Emacs" teksta editora izmantošanu un ir domāta tehniskākiem lietotājiem mazāk 
+lietotājiem draudzīgas funkcionalitātes dēļ. 
+
+Pašlaik neviens no esošiem risinājumiem neatbalsta minēto specializēto atmiņas
+kartīšu veidu importu.
+
+== Pasūtītājs
+
+Programmatūras produkts tiek izstrādāts pēc darba autora iniciatīvas
+kvalifikācijas darba ietvaros.
+
+== Produkta perspektīva
+
+Risinājums ir patstāvīga darbvirmas lietotne. Lietotnes izstrādē ir izmantotas
+lietotnes saskarnes bibliotēkas un programmēšanas valodas standarta bibliotēka.
+Risinājums lasīs un izmainīs teksta failus no lietotāja norādītās direktorijas.
+
+== Darījumprasības
+
++ Kartīšu failu apstrāde, izmantojot definēto domēna specifikas valodu;
++ Kartīšu saraksta veidošana;
++ Definēto jautājumu veidu tekstuāla atspoguļošana;
++ Definēto jautājumu veidu interaktīva mācīšanas funkcija;
++ Mācīšanās ar atkārtošanu ar intervāliem;
++ Kartīšu pievienošana, modifikācija un dzēšana sarakstā;
++ Vairāku kartīšu failu apstrāde direktorijā;
++ Kartīšu saglabāšana no saraksta.
+
+== Pieņēmumi un atkarības
+
++ Lietotnes var tikt uzbūvēta darbam uz Windows vai Linux sistēmām, uz kurām ir
+  pieejamas risinājumā izmantotas saskarnes bibliotēkas;
++ Lietotājs atbild par atmiņas kartīšu failu glabāšanu;
+
+#pagebreak(weak: true)
+= Programmatūras prasību specifikācija
+
+== 0. līmeņa datu plūsmas diagramma (DPD)
+
+
+
+
+#pagebreak(weak: true)
+= Programmatūras projektējuma apraksts