Feedback DD - Frontend

[bonicim]

Ref: https://github.com/CaseManagementAI/CommonAssessmentTool/wiki/Design-Document-%E2%80%90-Frontend

Good first draft. Thorough and good detail on tech stacks, implementation, and deployment.

However, there are some things that are missing that would make this design document stronger, informative, and thoughtful.

First, when discussing technology stacks or any design decision in general, you should include a discussion on the pros/cons of why you chose that direction. You should also mention any alternatives that you considered and also discuss the tradeoffs between your final decision versus other decisions.

Second, you should have a section that discusses how your system interacts and is in context to the larger system; look at this diagram as an example: https://www.industrialempathy.com/img/remote/2mPr0N-640w.avif It provides a good visual of the thing you're trying to build in the grand scheme of things.

Third, you should have a goals and non-goals section. Doing so will help you focus on the main thing (bigger picture) in light of all the technical details, decisions, and architecture that your document plans to execute.