Suborbital-Systems/ReadySetGit
2
0
Fork 0
Code Pull Requests Packages Projects Releases Activity
c38ee6b9a2
ReadySetGit/Features.md

494 lines
9.5 KiB
Markdown
Raw Normal View History

Fix markdown lint errors
2023-03-24 16:29:16 +00:00
<!-- markdownlint-disable-next-line first-line-h1 -->
lint formatting fixes
2018-08-23 17:23:45 +00:00
##### Project
::PROJECT-NAME
##### Internal Release Number
initial import
2018-08-14 12:48:17 +00:00
::X.Y.Z
lint formatting fixes
2018-08-23 17:23:45 +00:00
##### Related Documents
GFM changes
2018-08-14 17:54:11 +00:00
- [SRS](SRS) > [Feature Set](Feature-Set) > Features
- [Feature format](Feature-Format)
- [Project proposal](Proposal) > [User needs](User-Needs)
GFM changes
2018-08-14 17:39:17 +00:00
- [SRS](SRS) > [Use case suite](Use-Case-Suite)
initial import
2018-08-14 12:48:17 +00:00
- ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
---
**Process impact:** This is a set of detailed feature descriptions.
Fix markdown lint errors
2023-03-24 16:29:16 +00:00
_TODO: For each feature listed in the [feature set](Feature-Set),
initial import
2018-08-14 12:48:17 +00:00
give a detailed description of the feature here. Describe each feature
in enough detail that it could be implemented by any member of the
development team (not only someone who already informally knows what to
Fix markdown lint errors
2023-03-24 16:29:16 +00:00
do)._
initial import
2018-08-14 12:48:17 +00:00
Fix markdown lint errors
2023-03-24 16:29:16 +00:00
_TIP: Start with a short textual description of each feature. Then, add
initial import
2018-08-14 12:48:17 +00:00
more formal information as needed to make each description precise and
Fix markdown lint errors
2023-03-24 16:29:16 +00:00
unambiguous. E.g.,_
initial import
2018-08-14 12:48:17 +00:00
Fix markdown lint errors
2023-03-24 16:29:16 +00:00
- _Precisely define valid inputs, and error handling_
- _Specify data structures with UML or logical schema_
- _Specify UI aspects of features with tiny mock-ups_
- _Specify key decisions with decision trees or tables_
- _Specify key algorithms with pseudo-code or flow charts_
- _Specify state-based behavior with state machines or tables_
- _Specify sequences of events with scenario diagrams_
initial import
2018-08-14 12:48:17 +00:00
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-00: Site Configuration
Priority: ::Essential
Effort: ::Days
Risk: ::Safe
Functional area(s): ::Administration
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-00](Use-Cases#UC-00) [UC-11](Use-Cases#UC-11)
initial import
2018-08-14 12:48:17 +00:00
Description:
::The site administrators will be able to configure:
- ::The site appearance by choosing a predefined CSS file
- ::Whether the site makes new clans public or private by default
- ::The email address to be used to send critical error reports
Notes and Questions:
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-01: User registration
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
Priority: **::Essential**
Effort: ::Days
Risk: ::Safe
Functional area(s): ::Administration
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
:: Visitors can come to the site and register themselves. They must provide the following information:
- ::username
- ::email address (twice to catch typos)
- ::real name
Precise Details:
- ::username must be unique (not equal to any other existing user name)
- ::username must be of the form ~~~[a-zA-Z0-9]{2,16}~~~ and is not case sensitive
- ::email address must be of the form ~~~[-a-zA-Z0-9_.]{2,16}@[-a-zA-Z0-9_.]{6,64}~~~
- ::both entries of the email address must match
- ::email address will be verified by sending the user's initial password there
- ::real name must not be empty
- ::leading and trailing spaces are stripped from all fields
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-02: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
Fix markdown lint errors
2023-03-24 16:29:16 +00:00
:: 1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
initial import
2018-08-14 12:48:17 +00:00
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-03: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-10: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-11: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-12: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-13: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-20: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-21: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-22: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-23: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-30: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-31: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-32: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
---
lint formatting fixes
2018-08-23 17:23:45 +00:00
initial import
2018-08-14 12:48:17 +00:00
### ::F-33: FEATURE NAME
Priority: ::Essential | Expected | Desired | Optional
Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD
GFM changes
2018-08-14 22:37:52 +00:00
Use case(s): ::[UC-01](Use-Cases#UC-01)
initial import
2018-08-14 12:48:17 +00:00
Description:
::1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
Precise Details:
- ::LOGICAL CONSTRAINT
- ::LOGICAL CONSTRAINT
Notes and Questions:
- ::NOTE
- ::QUESTION
Copy Permalink