MorsePODHwDocs/Features.md at 262f115a388fbeb89f96e586d030f60964d326ab

Suborbital-Systems/MorsePODHwDocs

Fork 0

Charles Wyble 262f115a38 initial import of readyset markdown template

2021-04-26 14:00:30 -05:00

9.4 KiB

Raw Blame History

Project

::PROJECT-NAME

Internal Release Number

::X.Y.Z

SRS > Feature Set > Features
Feature format
Project proposal > User needs
SRS > Use case suite
::LINKS TO RELEVANT STANDARDS
::LINKS TO OTHER DOCUMENTS

Process impact: This is a set of detailed feature descriptions.

TODO: For each feature listed in the feature set, 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 do).

TIP: Start with a short textual description of each feature. Then, add more formal information as needed to make each description precise and unambiguous. E.g.,

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

::F-00: Site Configuration

Priority: ::Essential

Effort: ::Days

Risk: ::Safe

Functional area(s): ::Administration

Use case(s): ::UC-00 UC-11

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:

::NOTE
::QUESTION

::F-01: User registration

Priority: ::Essential

Effort: ::Days

Risk: ::Safe

Functional area(s): ::Administration

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

::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

Use case(s): ::UC-01

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

9.4 KiB Raw Blame History

Project

Internal Release Number

Related Documents

::F-00: Site Configuration

::F-01: User registration

::F-02: FEATURE NAME

::F-03: FEATURE NAME

::F-10: FEATURE NAME

::F-11: FEATURE NAME

::F-12: FEATURE NAME

::F-13: FEATURE NAME

::F-20: FEATURE NAME

::F-21: FEATURE NAME

::F-22: FEATURE NAME

::F-23: FEATURE NAME

::F-30: FEATURE NAME

::F-31: FEATURE NAME

::F-32: FEATURE NAME

::F-33: FEATURE NAME

9.4 KiB

Raw Blame History