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

Format markdown

Browse Source
This commit is contained in:
William Sandner 2021-08-02 18:21:55 +02:00
parent fd7626907d
commit 26c8ad888a
2 changed files with 59 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Words-of-Wisdom-Glossary-and-Data-Dictionary.md
View File

@ -1,6 +1,8 @@
# Glossary
Line-by-line Instructions
Project-specific Terms
## Line-by-line Instructions
### Project-specific Terms
Briefly define project-specific terms. Write the definitions in enough detail that a new member of the project team could understand all the terms. Writing project-specific definitions in the glossary helps to keep other project documents short and precise while still being understandable.
The glossary document can also serve as a simple data dictionary.

80
Words-of-Wisdom-SRS.md
View File

@ -1,33 +1,63 @@
# SRS
Line-by-line Instructions
Introduction
## Line-by-line Instructions
### Introduction
This section provides a brief introduction to the software requirements specification. To keep this section brief, the background information on the project goals and scope and the recorded user needs are linked rather than duplicated here.
Use Cases
### Use Cases
Use cases are a very important part of the SRS. They are written in a special format in their own use case document.
Functional Requirements
### Functional Requirements
Feature specifications are a very important part of the SRS. They are written in a special format in their own features document.
What are the usability requirements?
List any specific usability requirements here. Refer to existing standards documents and write new requirements in as "shall" (sentences that use the word "shall").
What are the reliability and up-time requirements?
List any specific reliability and up-time requirements here. Refer to existing standards documents and write new requirements in as "shall" (sentences that use the word "shall").
What are the safety requirements?
List any specific safety requirements here. Refer to existing standards documents and write new requirements in as "shall" (sentences that use the word "shall").
What are the security requirements?
List any specific security requirements here. Refer to existing standards documents and write new requirements in as "shall" (sentences that use the word "shall").
What are the performance and scalability requirements requirements?
List any specific performance requirements here. Refer to existing standards documents and write new requirements in as "shall" (sentences that use the word "shall").
What are the maintainability and upgradability requirements?
List any specific maintainability and upgradability requirements here. Refer to existing standards documents and write new requirements in as "shall" (sentences that use the word "shall").
What are the supportability and operability requirements?
List any specific supportability and operability requirements here. Refer to existing standards documents and write new requirements in as "shall" (sentences that use the word "shall").
What are the business lifecycle requirements?
List any specific business lifecycle requirements here. Refer to existing standards documents and write new requirements in as "shall" (sentences that use the word "shall").
What are the system hardware requirements?
### What are the usability requirements?
List any specific usability requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall").
### What are the reliability and up-time requirements?
List any specific reliability and up-time requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall").
### What are the safety requirements?
List any specific safety requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall").
### What are the security requirements?
List any specific security requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall").
### What are the performance and scalability requirements requirements?
List any specific performance requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall").
### What are the maintainability and upgradability requirements?
List any specific maintainability and upgradability requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall").
### What are the supportability and operability requirements?
List any specific supportability and operability requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall").
### What are the business lifecycle requirements?
List any specific business lifecycle requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall").
### What are the system hardware requirements?
List any specific system hardware requirements here. These are the true minimum requirements. You might present somewhat higher system requirements to customers to give a margin of extra capacity.
What are the pre-installed software requirements?
### What are the pre-installed software requirements?
List any specific pre-installed software requirements here.
What programmatic interfaces must be provided?
### What programmatic interfaces must be provided?
List any specific API requirements here. Refer to existing standards documents. Do not write API specs directly in this document.
What are the data import and export requirements?
List any specific import and export requirements here. Refer to existing standards documents and write new requirements in as "shall" (sentences that use the word "shall").
### What are the data import and export requirements?
List any specific import and export requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall").