Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create an "Architecture Decision Log" #78

Closed
2 tasks
LocalNewsTV opened this issue May 17, 2024 · 1 comment
Closed
2 tasks

Create an "Architecture Decision Log" #78

LocalNewsTV opened this issue May 17, 2024 · 1 comment
Assignees
Labels
Documentation Improvements or additions to documentation Nice to have Bonus tasks that will improve the quality of the project Task Work to be done

Comments

@LocalNewsTV
Copy link
Contributor

LocalNewsTV commented May 17, 2024

Describe the task

As a QuackStack developer I want To document my design and decision process So That I have a record of tools we're using and have researched laying out pros and cons

Acceptance Criteria

  • 'Architecture Decision Log' page created in Wiki
  • A few entries created around the tools you chose and are using for this project

Additional context

  • The main purpose is advancing the documentation in the repo, and creating a showcase for you as student developers to show off.
  • This is a living document, it should be updated as development proceeds
  • It doesn't have to be heavily detailed, a couple of bullet points is perfectly fine
  • Document design is your choice (Pro and Con list is easiest)
  • Having a link to Official documentation can be useful (just an option)
  • Don't just use ChatGPT
  • Examples:
    • Why did you choose postgres
      • Why did you not use MySQL
    • Why React?
    • Why Express?
  • Ticket Add Husky to the project #48 is a golden example of what sort of things you would add to a Architecture Decision Log
@LocalNewsTV LocalNewsTV added Task Work to be done Nice to have Bonus tasks that will improve the quality of the project labels May 17, 2024
@GDamaso GDamaso added the Documentation Improvements or additions to documentation label May 25, 2024
@LocalNewsTV
Copy link
Contributor Author

Well done on the work so far :) Far more detailed than I was expecting when I asked for it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Nice to have Bonus tasks that will improve the quality of the project Task Work to be done
Projects
None yet
Development

No branches or pull requests

3 participants