Overall todo list for spec doc milestone

[lwjohnst86]

This issue will track some todo items related to completing a specification report that we can send to get externally reviewed. The main issue tracker related to it though is this milestone. I'll add todo items as we progress. Ultimately, we want to have a final spec doc that I've created at design/_report.qmd.

Inside the report document are "tags" that look like {{ include FILENAME }}. These include tags will insert the contents of the file into that location in the document. So each of those files need to be completed before this report is ready to be sent out for review. I'll assign each file to a person for them to complete and write inside that file. I'll list all the files to complete below (with the assigned person). Issues specific to each file that come up, I will create a new issue and put it into the milestone.

Completed issues:

• seedcase-project/design#32
• seedcase-project/seedcase-project#78

[lwjohnst86]

These are some links (mainly for me) that describe how to write architecture documents:

• https://c4model.com/
• https://www.linkedin.com/pulse/effective-architecture-documentation-arc42-c4-torsten-mosis/
• https://www.innoq.com/en/blog/brief-introduction-to-arc42
• https://www.edrawsoft.com/article/data-architecture-diagram.html
• https://arc42.org/
• https://thepracticaldeveloper.com/
• https://nocomplexity.com/documents/arplaybook/introduction.html

Examples:

• https://biking.michael-simons.eu/docs/index.html
• https://hsc.aim42.org/documentation/hsc_arc42.html