Lecture - 2024/11/29 - Githubissues

Notes:

Design Doc informal presentation on Mon Jan 13. 15 minute meeting with TA, schedule to be announced later.
Rev0 demo is Feb 3.
Mindset to have is to finish the project, or else change the scope.
Final Doc/Rev 1 is focused on addressing feedback from rev0. Take all documents we originally did and look a second time, did we take feedback we were given and improve those documents. One way to show is take rev0 and anything removed put cross out or added in red. OR use github issues on feedback to code that addressed it and have hyperlink which you can put in a table. Put this in the table at the top with preamble about what you changed.
Put content into README files.
Address the github issues given by other teams. Need to address why the issue is being closed, even if don't take their feedback.
We have flexibility with the design doc template, if we decide something like UML would be better.
Document our user interface into pages through figma with the interactions. Can also hand draw it and embed the images in our document. Doesn't have to be formal.
Wants the critical part of our model/documentation to be formalized by a finite state machine, or some other mathematical means.
If you use external libraries, you would likely include it as a module but you wont worry about its internal implementation.

Spitgranger / SyncMaster