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

docs: 📝 aggregate quality requirements for software architecture #100

Merged
merged 10 commits into from
Jun 28, 2024

Conversation

K-Beicher
Copy link
Contributor

@K-Beicher K-Beicher commented Jun 20, 2024

Description

  • This PR adds the first draft of the quality requirements document, as well as a small edit of two existing pages.

Related Issues

Closes #11, #29, #93

See also Issues #29, #93

Reviewer Focus

This PR requires an in-depth review.

There is a link to the ISO standard at the start of the document, it may be useful to read through that before reviewing.

  1. Do you agree with the sections picked out
  2. Are you happy with the focus in descriptions of the four focus areas.

Checklist

For general documentation:

  • Spell-check
    • US
    • UK
  • Did the page(s) preview correctly on your machine without breaking
  • New category words (keywords) (if any) added to the code snippet file

@K-Beicher K-Beicher self-assigned this Jun 20, 2024
@K-Beicher K-Beicher requested a review from a team as a code owner June 20, 2024 11:31
@K-Beicher K-Beicher linked an issue Jun 20, 2024 that may be closed by this pull request
Copy link
Member

@lwjohnst86 lwjohnst86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice!! 🎉 I made some suggestion ☺️

Comment on lines 203 to 208
| Goals | Scenarios |
|--------------------|----------------------------------------------------|
| Beginner-friendly interfaces | We want non-technical users to use this, therefore it should be easy to learn and use. |
| Comprehensive functionality and easy to use | All apps under the Seedcase banner should be able to do what we need them to do, with ease. |
| Reliable and robust | As much as possible we want to simplify the applications and ensure that there is comprehensive error handling. |
| Secure and legally compliant | Seedcase software currently targets health data, so it needs to be compliant with privacy and security laws. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is fine to not duplicate things at all and instead move this table over to the quality requirements page at the top as like a "summary" section.

Copy link
Contributor Author

@K-Beicher K-Beicher Jun 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lwjohnst86 So leave nothing in the introduction about quality requirements?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@K-Beicher yea, since we can link to the document rather than have duplicate information.

software/quality-requirements.qmd Outdated Show resolved Hide resolved
software/quality-requirements.qmd Outdated Show resolved Hide resolved
software/quality-requirements.qmd Outdated Show resolved Hide resolved
software/quality-requirements.qmd Outdated Show resolved Hide resolved
software/quality-requirements.qmd Outdated Show resolved Hide resolved
software/quality-requirements.qmd Outdated Show resolved Hide resolved
software/solution-strategy.qmd Outdated Show resolved Hide resolved
@K-Beicher K-Beicher requested a review from lwjohnst86 June 26, 2024 06:40
lwjohnst86
lwjohnst86 previously approved these changes Jun 28, 2024
@lwjohnst86 lwjohnst86 changed the title Docs/quality requirements for architecture docs: 📝 aggregate quality requirements for software architecture Jun 28, 2024
@lwjohnst86 lwjohnst86 merged commit d8b1c86 into main Jun 28, 2024
@lwjohnst86 lwjohnst86 deleted the docs/quality-requirements-for-architecture branch June 28, 2024 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
2 participants