uulm-smart-sensing / documentation

0 stars 0 forks source link

refactor the architecture according to the current implementation #40

Closed fgardt closed 1 year ago

fgardt commented 1 year ago

In GitLab by @Merseleo on Mar 27, 2023, 16:19

Problem description

Currently the software design document and the (planned) implementation do not match anymore. Because the design document should help to get an overview of the implementation, it is recommended to keep the design up-to-date, if the implementation do not follow the architecture or diagrams.

Enhancement

Solution

So we should inspect the entire code and the entire design document and compare the diagrams with the implementation. After the comparison, we should document the entire differences and update the design and maybe extend it.

/cc @Slartibartfass2

fgardt commented 1 year ago

In GitLab by @Shiroen95 on Jun 6, 2023, 17:19

mentioned in commit 426eebaa60a4f4aae4e5026b71fa1112a1b18262