Software Design Documentation To-Do (March 2022 onwards)

Holds discussions about Wimborne Model Town's River System Design and any relevant drawings.

Relevant documents are available at https://wmtprojectsforum.altervista.org ... les/Design
hamishmb
Posts: 1891
Joined: 16/05/2017, 16:41

Re: Software Design Documentation To-Do (March 2022 onwards)

Post by hamishmb »

Also, I think these logic flowcharts probably belong with the software API documentation and overview (/docs in the rivercontrolsystem repo), along with Patrick's diagrams. This allows them to be shown with the rest of the software documentation for consistency.

We could also link to these from the Software Design Spec. Thoughts?
Hamish
TerryJC
Posts: 2616
Joined: 16/05/2017, 17:17

Re: Software Design Documentation To-Do (March 2022 onwards)

Post by TerryJC »

Sounds fine to me.
Terry
hamishmb
Posts: 1891
Joined: 16/05/2017, 16:41

Re: Software Design Documentation To-Do (March 2022 onwards)

Post by hamishmb »

Note: Patrick wrote state diagrams for his logic, not flowcharts, so there are still flowcharts to be created at some point.

Owing to the very object-orientation-heavy design pattern he used in this logic, I suspect it will be best for me to write the flowcharts.
Hamish
Post Reply