design/software-architecture/risks: Text suggestions

[signekb]

Introduction

• This entry could benefit from a short introduction. What is meant by risks and technical debt? What will this entry contain? I have added a couple of sentences in the branch design-text-mods. However, I'm still not sure about what the sections starting with "To address these issues, the following strategies are recommended:" are about (see "To-do comment" below, which addresses the same thing).

Django Framework:

• "the application" and "the codebase" --> is that the Seedcase software/product or Django?

  • https://github.com/seedcase-project/seedcase-project/blob/d6086fe2ca077597dc7cf00db9d863055f04139e/design/software-architecture/risks.qmd#L14-L22

• To-do comment at L26 (which I agree with, but should be resolved so we don't forget :o) ):

  • https://github.com/seedcase-project/seedcase-project/blob/d6086fe2ca077597dc7cf00db9d863055f04139e/design/software-architecture/risks.qmd#L24-L32
  • Is this something we are addressing already, something we should address, or something else? Are these recommendations from us to us?
  • Is "the team" = the Seedcase team?

Django REST API Framework

• Could the points below be made a bit clearer with examples, maybe? E.g., add examples of which endpoints that are poorly documented?
  • https://github.com/seedcase-project/seedcase-project/blob/d6086fe2ca077597dc7cf00db9d863055f04139e/design/software-architecture/risks.qmd#L40-L45
  • Are "developers" = the Seedcase team or developers in general?

Front End

• This section is the only section that is not explicitly tied with a technology (e.g., Django, Django REST API Framework, Docker in the previous sections). Should that be added?

[martonvago]

I generally agree with this, especially that it's not always clear whether "application" refers to Seedcase or to the framework being discussed. I also have the feeling that some points in the tech debt section refer to the old codebase?