Suborbital-Systems-Public/ReadySetGit
3
0
Fork 0
Code Pull Requests Packages Projects Releases Activity

Linter cleanup

Browse Source
This commit is contained in:
William Sandner
2018-08-24 12:30:24 +02:00
parent af07911365
commit fb1bdcf829
26 changed files with 664 additions and 694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

187
Use-Cases.md
View File

@@ -1,16 +1,20 @@
##### Project
::PROJECT-NAME
##### Internal Release Number
::X.Y.Z
##### Related Documents
- [SRS](SRS) > [Use Case Suite](Use-Case-Suite) > Use Cases
- [Project proposal](Proposal) > [User needs](User-Needs), [SRS](SRS) > [Feature set](Feature-Set)
- [Use case format](Use-Case-Format)
- ::LINK TO USE CASE DIAGRAM
- ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS
- [Project proposal](Proposal) > [User needs](User-Needs), [SRS](SRS) > [Feature set](Feature-Set)
- [Use case format](Use-Case-Format)
- ::LINK TO USE CASE DIAGRAM
- ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS
---
*TODO: Note any aspects that are common to all use cases here. This helps
@@ -21,16 +25,16 @@ note it's specific value to replace or add to the default.*
**Direct Actors:**
- ::User: end-user in any role
- ::System: The system being built
- ::When actors are not listed, assume User is doing it.
- ::Items beginning with "see" indicate that System has presented a new screen.
- ::User: end-user in any role
- ::System: The system being built
- ::When actors are not listed, assume User is doing it.
- ::Items beginning with "see" indicate that System has presented a new screen.
**Stakeholders:**
::Project Owners and other members
**Prereq:**
**Prerequisite:**
::User is logged in
@@ -47,6 +51,7 @@ cases first and come back to less important ones later.*
[guidelines for writing use cases](Use-Case-Format#further-information).*
---
### UC-00: Configure the site
**Summary:**
@@ -74,18 +79,18 @@ cases first and come back to less important ones later.*
5. ::confirm changes
6. ::see SiteConfiguration page again, with updated values
**Alternative Scenario Extensions:**
- ::If the timezone abbreviation is incorrect, an error message will be displayed and no changes will be made.
**Notes and Questions**
**Notes and Questions:**
- ::How will administrators know the right timezone abbreviation?
- They would know it if they live in that timezone. Maybe we could
provide a drop-down list of all choices, but each would need some explanation.
---
### UC-01: Register as a new user
**Summary:**
@@ -113,13 +118,14 @@ cases first and come back to less important ones later.*
**Alternative Scenario Extensions:**
- ::If the username is taken, then the system will suggest an available username based on the user's email address and/or real name.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::QUESTION
---
### UC-02: Request new password
**Summary:**
@@ -138,12 +144,13 @@ cases first and come back to less important ones later.*
- ::TODO
**Notes and Questions**
**Notes and Questions:**
- ::Alternatively, we could use password hints.
---
### UC-03: Edit user profile
### UC-03: Edit user profile
** Summary:**
@@ -162,6 +169,7 @@ cases first and come back to less important ones later.*
- ::TODO
---
### UC-04: View user profile
**Summary:**
@@ -185,6 +193,7 @@ cases first and come back to less important ones later.*
- ::TODO
---
### UC-10: Create course
**Summary:**
@@ -201,7 +210,7 @@ cases first and come back to less important ones later.*
**Direct Actors:**
::Admin: Web-site adminisator
::Admin: Web-site administrator
**Main Success Scenario:**
@@ -212,6 +221,7 @@ cases first and come back to less important ones later.*
- ::see course list with new course added
---
### UC-11: View catalog description
**Summary:**
@@ -232,14 +242,13 @@ cases first and come back to less important ones later.*
- ::click link to course description
- ::see course description in pop-up window
- ::close pop-up window to continue using application
**Notes and Questions:**
**Notes and Questions**
- ::How do we accommodate users that configure their browsers to block pop-ups?
---
---
### UC-20: Enroll in course
**Summary:**
@@ -270,6 +279,7 @@ cases first and come back to less important ones later.*
- ::Course capacity and number of students currently waiting should be shown so that students may choose the section that they are most likely to be able to get into.
---
### UC-21: Drop a course
**Summary:**
@@ -293,12 +303,13 @@ cases first and come back to less important ones later.*
- ::confirm choice
- ::see revised list of currently enrolled courses
**Notes and Questions**
**Notes and Questions:**
- ::Only one course can be dropped at a time. There is no need to allow students to quickly drop more than one course.
- ::It would be nice to offer an atomic "switch sections" operation that drops and adds another, or does nothing.
---
### UC-30: View room description
**Summary:**
@@ -318,6 +329,7 @@ cases first and come back to less important ones later.*
- ::TODO
---
### UC-31: Assign course to room
**Summary:**
@@ -339,6 +351,7 @@ cases first and come back to less important ones later.*
- ::STEP
---
### UC-40: USE CASE NAME
**Summary:**
@@ -361,7 +374,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -381,14 +394,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-41: USE CASE NAME
**Summary:**
@@ -411,7 +425,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -431,14 +445,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-42: USE CASE NAME
**Summary:**
@@ -461,7 +476,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -481,14 +496,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-50: USE CASE NAME
**Summary:**
@@ -511,7 +527,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -531,14 +547,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-51: USE CASE NAME
**Summary:**
@@ -561,7 +578,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -581,14 +598,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-52: USE CASE NAME
**Summary:**
@@ -611,7 +629,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -631,14 +649,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-60: USE CASE NAME
**Summary:**
@@ -661,7 +680,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -681,14 +700,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-61: USE CASE NAME
**Summary:**
@@ -711,7 +731,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -731,14 +751,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-62: USE CASE NAME
**Summary:**
@@ -761,7 +782,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -781,14 +802,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-70: USE CASE NAME
**Summary:**
@@ -811,7 +833,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -831,14 +853,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-71: USE CASE NAME
**Summary:**
@@ -861,7 +884,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -881,14 +904,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-72: USE CASE NAME
**Summary:**
@@ -911,7 +935,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -931,14 +955,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-80: USE CASE NAME
**Summary:**
@@ -961,7 +986,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -981,14 +1006,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-81: USE CASE NAME
**Summary:**
@@ -1011,7 +1037,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -1031,14 +1057,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-82: USE CASE NAME
**Summary:**
@@ -1061,7 +1088,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -1081,14 +1108,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-90: USE CASE NAME
**Summary:**
@@ -1111,7 +1139,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -1131,14 +1159,15 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION
- ::QUESTION
---
### UC-91: USE CASE NAME
**Summary:**
@@ -1161,7 +1190,7 @@ cases first and come back to less important ones later.*
::STAKEHOLDER, STAKEHOLDER, STAKEHOLDER
**Prereq:**
**Prerequisite:**
- ::PRECONDITION
- ::PRECONDITION
@@ -1181,8 +1210,8 @@ cases first and come back to less important ones later.*
- ::If CONDITION, then ALTERNATIVE STEPS.
- ::NOTES or DETAILS.
**Notes and Questions**
**Notes and Questions:**
- ::NOTE
- ::NOTE
- ::QUESTION