aboutsummaryrefslogtreecommitdiff
path: root/doc/diagrams
diff options
context:
space:
mode:
authorInigoGutierrez <inigogf.95@gmail.com>2021-06-23 22:25:55 +0200
committerInigoGutierrez <inigogf.95@gmail.com>2021-06-23 22:25:55 +0200
commit6968123fadde3b864882851e2cfc99b2e724dec7 (patch)
tree2608e11074e857b5ddedd8255d4112d23083dd71 /doc/diagrams
parent08bd7d1bd0f9a564cff7ee7f616d62f234a54057 (diff)
downloadimago-6968123fadde3b864882851e2cfc99b2e724dec7.tar.gz
imago-6968123fadde3b864882851e2cfc99b2e724dec7.zip
Docs: Written initial planification and system analysis sections.
Diffstat (limited to 'doc/diagrams')
-rw-r--r--doc/diagrams/analysisClasses.puml27
-rw-r--r--doc/diagrams/modules.puml2
-rw-r--r--doc/diagrams/planificationWorkPlanEngine.puml30
-rw-r--r--doc/diagrams/planificationWorkPlanGame.puml18
-rw-r--r--doc/diagrams/skinparamsGantt.puml14
-rw-r--r--doc/diagrams/useCases.puml18
6 files changed, 108 insertions, 1 deletions
diff --git a/doc/diagrams/analysisClasses.puml b/doc/diagrams/analysisClasses.puml
new file mode 100644
index 0000000..5f1ccde
--- /dev/null
+++ b/doc/diagrams/analysisClasses.puml
@@ -0,0 +1,27 @@
+@startuml
+
+!include skinparams.puml
+
+package GameModule {
+ class GameIO
+ class GameTree
+ class GameMove
+}
+
+GameIO -> GameTree
+GameTree -> GameMove
+
+package EngineModule {
+ class EngineIO
+ class EngineLogic
+ interface DecisionAlgorithm
+ class DecisionAlgorithm1
+ class DecisionAlgorithm2
+}
+
+EngineIO -> EngineLogic
+EngineLogic -> DecisionAlgorithm
+DecisionAlgorithm <|.. DecisionAlgorithm1
+DecisionAlgorithm <|.. DecisionAlgorithm2
+
+@enduml
diff --git a/doc/diagrams/modules.puml b/doc/diagrams/modules.puml
index 064be1d..5b8d78c 100644
--- a/doc/diagrams/modules.puml
+++ b/doc/diagrams/modules.puml
@@ -1,6 +1,6 @@
@startuml
-!include ./skinparams.puml
+!include skinparams.puml
!include GameState.pumlc
!include SGF.pumlc
diff --git a/doc/diagrams/planificationWorkPlanEngine.puml b/doc/diagrams/planificationWorkPlanEngine.puml
new file mode 100644
index 0000000..53bd5ea
--- /dev/null
+++ b/doc/diagrams/planificationWorkPlanEngine.puml
@@ -0,0 +1,30 @@
+@startgantt
+
+!include skinparams.puml
+!include skinparamsGantt.puml
+
+'printscale weekly
+Sunday are closed
+
+Project starts 2021-01-04
+
+-- Engine Implementation --
+[Engine modelling] as [EM] starts 2021-01-04
+[Engine modelling] as [EM] lasts 1 week
+[Engine implementation] as [EI] lasts 5 weeks
+[Engine testing] as [ET] lasts 5 weeks
+
+-- Algorithms Implementations --
+[Algorithm research] as [AR] lasts 1 week
+[Monte Carlo implementation] as [MCI] lasts 3 weeks
+[Extra algorithms research] as [EAR] lasts 2 weeks
+[Extra algorithms implementation] as [EAI] lasts 4 weeks
+
+[EM] -> [AR]
+[AR] -> [MCI]
+[AR] -> [EI]
+[AR] -> [ET]
+[EI] -> [EAR]
+[EAR] -> [EAI]
+
+@endgantt
diff --git a/doc/diagrams/planificationWorkPlanGame.puml b/doc/diagrams/planificationWorkPlanGame.puml
new file mode 100644
index 0000000..427564a
--- /dev/null
+++ b/doc/diagrams/planificationWorkPlanGame.puml
@@ -0,0 +1,18 @@
+@startgantt
+
+!include skinparams.puml
+!include skinparamsGantt.puml
+
+'printscale weekly
+Sunday are closed
+
+Project starts 2020-11-02
+
+-- Game Implementation --
+[Domain modelling] as [DM] lasts 6 days
+[Domain implementation] as [DI] lasts 30 days
+[Domain testing] as [DT] lasts 30 days
+[DM] -> [DI]
+[DM] -> [DT]
+
+@endgantt
diff --git a/doc/diagrams/skinparamsGantt.puml b/doc/diagrams/skinparamsGantt.puml
new file mode 100644
index 0000000..5355d5f
--- /dev/null
+++ b/doc/diagrams/skinparamsGantt.puml
@@ -0,0 +1,14 @@
+@startuml
+
+<style>
+ganttDiagram {
+ task {
+ FontSize 15
+ }
+ separator {
+ FontSize 20
+ }
+}
+</style>
+
+@enduml
diff --git a/doc/diagrams/useCases.puml b/doc/diagrams/useCases.puml
new file mode 100644
index 0000000..e3da3f8
--- /dev/null
+++ b/doc/diagrams/useCases.puml
@@ -0,0 +1,18 @@
+@startuml
+
+!include skinparams.puml
+
+actor "Human Player" as player
+actor "Human User" as user
+actor "GUI Program" as gui
+
+usecase "Play a match" as play
+usecase "Generate a move" as genMove
+usecase "Use as backend for machine player" as backend
+
+player --> play
+user --> genMove
+gui --> genMove
+gui --> backend
+
+@enduml