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

GFM changes

Browse Source
This commit is contained in:
William Sandner 2018-08-15 00:37:52 +02:00
parent e6c1356aa0
commit 539106de83
21 changed files with 431 additions and 896 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Features.md
View File

@ -44,7 +44,7 @@ Risk: ::Safe
Functional area(s): ::Administration Functional area(s): ::Administration
Use case(s): ::[UC-00](use-cases#UC-00) [UC-11](use-cases#UC-11) Use case(s): ::[UC-00](Use-Cases#UC-00) [UC-11](Use-Cases#UC-11)
Description: Description:
@ -68,7 +68,7 @@ Risk: ::Safe
Functional area(s): ::Administration Functional area(s): ::Administration
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
:: Visitors can come to the site and register themselves. They must provide the following information: :: Visitors can come to the site and register themselves. They must provide the following information:
@ -103,7 +103,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
:: 1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION. :: 1-4 PARAGRAPHS. USE BULLETS OR TABLES TO ORGANIZE INFORMATION. LINK TO WORKSHEETS OR ADDITIONAL INFORMATION.
@ -129,7 +129,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -156,7 +156,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -184,7 +184,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -212,7 +212,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -239,7 +239,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -267,7 +267,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -295,7 +295,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -323,7 +323,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -351,7 +351,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -378,7 +378,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -406,7 +406,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -434,7 +434,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:
@ -462,7 +462,7 @@ Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(s): ::WORD, WORD, WORD
Use case(s): ::[UC-01](use-cases#UC-01) Use case(s): ::[UC-01](Use-Cases#UC-01)
Description: Description:

2
Resource-Needs.md
View File

@ -10,7 +10,7 @@
##### Related Documents: ##### Related Documents:
- [Project proposal](Proposal) - [Project proposal](Proposal)
- [Project plan](Project-Plan) - [Project plan](Project-Plan)
- [QA plan](qa-plan.html) - [QA plan](QA-Plan)
- [Software development methodology](SDM) - [Software development methodology](SDM)
- [Glossary](Glossary) - [Glossary](Glossary)
--- ---

42
Review-Meeting-Checklists.md
View File

@ -1,24 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# Review Meeting Checklists # Review Meeting Checklists
--- ---
@ -39,24 +18,3 @@
- ::[More C++ style guides](http://directory.google.com/Top/Computers/Programming/Languages/C%2B%2B/Style/) - ::[More C++ style guides](http://directory.google.com/Top/Computers/Programming/Languages/C%2B%2B/Style/)
- ::[More Java style guides](http://directory.google.com/Top/Computers/Programming/Languages/Java/Coding_Standards/) - ::[More Java style guides](http://directory.google.com/Top/Computers/Programming/Languages/Java/Coding_Standards/)
- ::[Python PEP 8 style guide](https://www.python.org/dev/peps/pep-0008/) - ::[Python PEP 8 style guide](https://www.python.org/dev/peps/pep-0008/)
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

54
Review-Meeting-Notes.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# [QA Plan](qa-plan.html) > Review Meeting Notes
---
##### Project: ##### Project:
::[PROJECTNAME](Home) ::[PROJECTNAME](Home)
@ -42,15 +18,15 @@
- ::PERSONNAME - ::PERSONNAME
##### Related documents: ##### Related documents:
- [QA Plan](QA-Plan) > Review Meeting Notes
- [Review Meeting Checklists](review-meeting-checklists.html) - [Review Meeting Checklists](Review-Meeting-Checklists)
--- ---
### Documents and Code Reviewed at this Meeting ### Documents and Code Reviewed at this Meeting
- ::[Feature list section of requirements](requirements.html#functional) - ::[Feature list section of requirements](#)
- ::[Multi-user section of requirements](requirements.html#multiuser) - ::[Multi-user section of requirements](#)
- ::[Hello.java](/source/browse/PROJECTNAME/src/Hello.java) - ::[Hello.java](/source/browse/PROJECTNAME/src/Hello.java)
- ::[HelloStream.java](/source/browse/PROJECTNAME/src/HelloStream.java) - ::[HelloStream.java](/source/browse/PROJECTNAME/src/HelloStream.java)
- ::[HelloPanel.java](/source/browse/PROJECTNAME/src/HelloPanel.java) - ::[HelloPanel.java](/source/browse/PROJECTNAME/src/HelloPanel.java)
@ -84,25 +60,3 @@ inspected, it still needs review.
::All defects and tasks identified in this review are being tracked in the ::All defects and tasks identified in this review are being tracked in the
issue tracker. issue tracker.
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

223
Risks.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# Risks
---
##### Project: ##### Project:
::[PROJECTNAME](Home) ::[PROJECTNAME](Home)
@ -35,6 +11,7 @@
##### References: ##### References:
- [Risk Management during Requirements](http://www.systemsguild.com/pdfs/s5req.lo%201.pdf) by Tom DeMarco and Tim Lister - [Risk Management during Requirements](http://www.systemsguild.com/pdfs/s5req.lo%201.pdf) by Tom DeMarco and Tim Lister
- [Taxonomy-Based Risk Identification](http://www.sei.cmu.edu/pub/documents/93.reports/pdf/tr06.93.pdf) by Carr, Konda, Monarch, Ulrich, and Walker (SEI) - [Taxonomy-Based Risk Identification](http://www.sei.cmu.edu/pub/documents/93.reports/pdf/tr06.93.pdf) by Carr, Konda, Monarch, Ulrich, and Walker (SEI)
--- ---
**Process impact:** This document records the major project risks, and **Process impact:** This document records the major project risks, and
@ -52,12 +29,78 @@ plans to control them. For each risk the plan should include:
general contingency plans. In this case you only need to give a general contingency plans. In this case you only need to give a
contingency plan if you have a special one for the particular risk. contingency plan if you have a special one for the particular risk.
The severity of a risk is its likelihood multiplied by its impact. Risks The severity of a risk is its likel
are classified as minor if they have low likelihood, negligible impact, ##### Project:
or medium likelihood and marginal impact. ::[PROJECTNAME](Home)
*TODO: You should update these lists regularly. They should be reviewed ##### Internal Release Number:
by customers and developers from time to time.* ::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
---ihood multiplied by its impact. Risks
are classified as minor if they hav
##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
---e low likelihood, negligible impact,
or medium likelihood and marginal i
##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
---mpact.
##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
---
*TODO: You should update these list
##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
---s regularly. They should be reviewed
by customers and developers from ti
##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
---me to time.*
### General contingency plans ### General contingency plans
@ -95,7 +138,7 @@ delivery date.
|-----------------|---------------------------------------------------------------------------------------------------------------------------------|------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|-------------------| |-----------------|---------------------------------------------------------------------------------------------------------------------------------|------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|-------------------|
| ::Requirements | Requirements are only partly known at project start. Customers may not allocate sufficient resources to exploring requirements. | Medium | Critical to Catastrophic | Requirements will be detailed first for the top priority goals. Indicator: Track the rate at which requirements are discovered. Contingency: request more customer effort. | Amber | Requirements Lead | | ::Requirements | Requirements are only partly known at project start. Customers may not allocate sufficient resources to exploring requirements. | Medium | Critical to Catastrophic | Requirements will be detailed first for the top priority goals. Indicator: Track the rate at which requirements are discovered. Contingency: request more customer effort. | Amber | Requirements Lead |
| ::Goals | Stakeholders goals may conflict. | Medium | Critical | Keep an explicit list of stakeholders goals. The project manager will report progress to each declared goal. | Green | Customers | | ::Goals | Stakeholders goals may conflict. | Medium | Critical | Keep an explicit list of stakeholders goals. The project manager will report progress to each declared goal. | Green | Customers |
| ::Communication | Communication problems in development team. They are dispersed among several sites, and have not worked together before. | Medium | Critical | Use these [tools](sdm#communication) to help communication. The main indicator of miscommunication will be software defects detected by our [QA activity](qa-plan). | Green | QA lead | | ::Communication | Communication problems in development team. They are dispersed among several sites, and have not worked together before. | Medium | Critical | Use these [tools](SDM#communication) to help communication. The main indicator of miscommunication will be software defects detected by our [QA activity](qa-plan). | Green | QA lead |
| ::Acceptance | Customer may accept delivery of the system although it does not really meet their goals. | Medium | Critical | Customers are asked to declare acceptance criteria as each release is planned. | Green | Customers | | ::Acceptance | Customer may accept delivery of the system although it does not really meet their goals. | Medium | Critical | Customers are asked to declare acceptance criteria as each release is planned. | Green | Customers |
| ::Scope | The total features requested may be beyond what the development team can deliver in the time available. | High | Marginal | Assign levels of important to the use cases. Make the first review of project scope after 12 months. | Green | Customers | | ::Scope | The total features requested may be beyond what the development team can deliver in the time available. | High | Marginal | Assign levels of important to the use cases. Make the first review of project scope after 12 months. | Green | Customers |
@ -108,11 +151,99 @@ impact of a risk has increased to make it a "major" risk.*
|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|-----------------| |-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|-----------------|
| ::Estimate | The development team might not be able to estimate the work time, preventing customers from deciding priorities effectively. | Medium | Marginal | The development team will gain experience in estimating the work, and deliver the first estimates after 12 months. We will compare estimated work to actual work. | Green | Project Manager | | ::Estimate | The development team might not be able to estimate the work time, preventing customers from deciding priorities effectively. | Medium | Marginal | The development team will gain experience in estimating the work, and deliver the first estimates after 12 months. We will compare estimated work to actual work. | Green | Project Manager |
| ::Retention | Some developers may leave the project before it is finished. | Medium | Marginal | Employing locations should provide support for continuing professional development. The project manager will discuss career goals with each developer, and try to assign tasks appropriately. | Green | Project Manager | | ::Retention | Some developers may leave the project before it is finished. | Medium | Marginal | Employing locations should provide support for continuing professional development. The project manager will discuss career goals with each developer, and try to assign tasks appropriately. | Green | Project Manager |
| ::Correctness | The system as delivered may have low take-up because of a lack of confidence in its correctness. | Low | Catastrophic | State of the art [QA activity](qa-plan). Contingency: stop development of new facilities until the quality of the existing code is assured. | Green | QA Lead | | ::Correctness | The system as delivered may have low take-up because of a lack of confidence in its correctness. | Low | Catastrophic | State of the art [QA activity](QA-Plan). Contingency: stop development of new facilities until the quality of the existing code is assured. | Green | QA Lead
| ::Usability | The system as delivered may have low take-up because of poor usability. | Low | Critical | We will have a UI style guide. Most of the development of the front end will be in close contact with customers. We will review usability later in the project. | Green | UI design lead | ##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
--- |
| ::Usability | The system as
##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
--- delivered may have low take-up because of poor usability.
##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
--- | Low
##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
--- | Critical | We will have a UI style guide. Most of the development of the front end will be in close contact with customers. We will review usability later in the project. | Green | UI design lead |
| ::Desire | The stated requirements might not match the customers' desires and ambitions for the system. | Low | Critical | Incremental delivery of versions will provide experience of using the system, which will help the customers to identify the real requirements. Indicator: a developer saying "I think they mean ...", a customer saying "They know what I mean". Contingency: request customer review of requirements. | Green | Customers | | ::Desire | The stated requirements might not match the customers' desires and ambitions for the system. | Low | Critical | Incremental delivery of versions will provide experience of using the system, which will help the customers to identify the real requirements. Indicator: a developer saying "I think they mean ...", a customer saying "They know what I mean". Contingency: request customer review of requirements. | Green | Customers |
| ::Changes | After requirements have been documented and agreed, development activities begin to based on them, first design then implementation. If the requirements change later then effort is wasted. | Low | Critical | A change control procedure is required, so changes are only made when the cost is worthwhile. Indicator: compare cost of change to new development. Contingency: request customer review of requirements. | Green | Project Manager | | ::Changes | After requirements have been documented and agreed, development activities begin to based on them, first design then implementation. If the requirements change later then effort is wasted. | Low | Critical | A change control procedure is required, so changes are only made when the cost is worthwhile. Indicator: compare cost of change t
| ::Process | Some developers may not cooperate in common standards and processes. | Low | Critical | QA to check conformance, then discussions in development team meetings to change the standard or the actual practice as appropriate. | Green | QA Lead | ##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
---o new development. Contingency: request customer review of requirements.
##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
--- | Green | P
##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
---roject Manager |
| ::Process | Some develope
##### Project:
::[PROJECTNAME](Home)
##### Internal Release Number:
::X.Y.Z
##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary)
---rs may not cooperate in common standards and processes. | Low | Critical | QA to check conformance, then discussions in development team meetings to change the standard or the actual practice as appropriate. | Green | QA Lead |
| ::Maintainability | The system as delivered might be hard to maintain. | Low | Marginal | We will review the code for maintainability. | Green | Lead Developer | | ::Maintainability | The system as delivered might be hard to maintain. | Low | Marginal | We will review the code for maintainability. | Green | Lead Developer |
| ::RISKNAME | ONE-TO-THREE-SENTENCES | Low or Medium or High | Negligible or Marginal or Critical or Catastrophic | ONE-TO-THREE-SENTENCES | Red or Amber or Green | PERSONNAME | | ::RISKNAME | ONE-TO-THREE-SENTENCES | Low or Medium or High | Negligible or Marginal or Critical or Catastrophic | ONE-TO-THREE-SENTENCES | Red or Amber or Green | PERSONNAME |
@ -130,7 +261,7 @@ Not yet active
### Risk Checklist ### Risk Checklist
#### Do the plans provide an indicator to detect each of the risks becoming active? #### Do the plans provide an indicator to detect each of the risks becoming active?
::Yes, if all activies are carried out as planned, we will know if any ::Yes, if all activities are carried out as planned, we will know if any
of the risks is becoming troublesome. of the risks is becoming troublesome.
::No, some risks could creep up on us. ::No, some risks could creep up on us.
@ -180,25 +311,3 @@ the project could deliver.
::No, everything depends on the alertness and strength of character of ::No, everything depends on the alertness and strength of character of
the project manager. the project manager.
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

48
SDM.md
View File

@ -1,51 +1,5 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# Software Development Methodology
---
*TODO: This template is not done yet. Feel free to contribute your ideas.* *TODO: This template is not done yet. Feel free to contribute your ideas.*
A Software Development Methodology is always specific to a given A Software Development Methodology is always specific to a given
company, but the outline of that document could be reused, as could some company, but the outline of that document could be reused, as could some
sections on common practices such as version control procedures. sections on common practices such as version control procedures.
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

52
SRS.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# Software Requirements Specification
---
##### Project: ##### Project:
::PROJECTNAME ::PROJECTNAME
@ -41,10 +17,10 @@
**Process impact:** The SRS precisely defines the software product that **Process impact:** The SRS precisely defines the software product that
will be built. Decisions made in writing the SRS are based on will be built. Decisions made in writing the SRS are based on
information in the [project proposal](proposal) and [user information in the [project proposal](Proposal) and [user
needs](User-Needs) documents. The SRS sets requirements that must needs](User-Needs) documents. The SRS sets requirements that must
be satisfied by the [system design](design). The SRS is verified be satisfied by the [system design](Design). The SRS is verified
and validated by activities outlined in the [QA plan](qa-plan.html). and validated by activities outlined in the [QA plan](QA-Plan).
### Introduction ### Introduction
@ -273,25 +249,3 @@ Details:
- ::The system will read and write valid .XYZ files used by - ::The system will read and write valid .XYZ files used by
OTHER APPLICATION OTHER APPLICATION
- ::DETAIL - ::DETAIL
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

67
Status-Report.md
View File

@ -67,8 +67,71 @@ words.
::Two major problems have been uncovered... ::Two major problems have been uncovered...
::We are approximately 30% of the way through the project plan, and <!-- End Markdown content -->
running about 2 days ahead of schedule... </xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>
the way through the project plan, and
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>
schedule...
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>
::The reason for the change in estimated release date is... ::The reason for the change in estimated release date is...

2
Summary.md
View File

@ -128,7 +128,7 @@ worksheets.*
### Quality Assurance ### Quality Assurance
*TODO: Briefly describe your quality goals and how you will achieve them. *TODO: Briefly describe your quality goals and how you will achieve them.
This is condensed from the [QA plan](qa-plan.html), [test This is condensed from the [QA plan](QA-Plan), [test
suite](test-suite), and [test cases](test-cases.html) documents.* suite](test-suite), and [test cases](test-cases.html) documents.*
#### What are your ranked quality goals? #### What are your ranked quality goals?

49
Target-and-Benefits.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# [Proposal](Proposal) > Target Audience and Benefits
---
##### Project: ##### Project:
::[PROJECTNAME](Home) ::[PROJECTNAME](Home)
@ -29,6 +5,7 @@
::X.Y.Z ::X.Y.Z
##### Related Documents: ##### Related Documents:
- [Proposal](Proposal) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs) - [Project proposal](Proposal) > [User needs](User-Needs)
- [Glossary](Glossary) - [Glossary](Glossary)
--- ---
@ -89,7 +66,7 @@ identify the type of customer or user that will benefit. Each benefit
should be in real-world terms, not involving just this product itself. should be in real-world terms, not involving just this product itself.
You may want to highlight benefits that are not offered by competing You may want to highlight benefits that are not offered by competing
products. Benefits to the development organization should be listed in products. Benefits to the development organization should be listed in
[Risks and Rewards](Project-Plan#risk_management).* [Risks and Rewards](Project-Plan#risk-management).*
*TIP: If you can rank benefits by value, use numbered lists (the HTML *TIP: If you can rank benefits by value, use numbered lists (the HTML
&lt;ol&gt; tag), otherwise use bullet lists (the HTML &lt;ul&gt; tag).* &lt;ol&gt; tag), otherwise use bullet lists (the HTML &lt;ul&gt; tag).*
@ -156,25 +133,3 @@ implementation, assume that you build the system as specified on time.*
1. ::Worst downside 1. ::Worst downside
2. ::Downside 2. ::Downside
3. ::Downside 3. ::Downside
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

23
Test-Case-Format.md
View File

@ -1,25 +1,6 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;"> ##### Related Documents:
<item><a href="index.html">Overview</a></item> - [QA Plan](QA-Plan) > [Test Suite](Test-Suite) > Test Case Format
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# [QA Plan](qa-plan.html) > [Test Suite](Test-Suite) > Test Case Format
--- ---
**Process impact:** This reference page documents the format of test **Process impact:** This reference page documents the format of test

59
Test-Cases.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# [QA Plan](qa-plan) > [Test Suite](test-suite) > Test&nbsp;Cases
---
##### Project: ##### Project:
::[PROJECTNAME](Home) ::[PROJECTNAME](Home)
@ -29,13 +5,14 @@
::X.Y.Z ::X.Y.Z
##### Related Documents: ##### Related Documents:
[System test case format](test-case-format) [QA Plan](QA-Plan) > [Test Suite](Test-Suite) > Test Cases
[System test case format](Test-Case-Format)
::LINKS TO RELEVANT STANDARDS ::LINKS TO RELEVANT STANDARDS
::LINKS TO OTHER DOCUMENTS ::LINKS TO OTHER DOCUMENTS
--- ---
### login-1: Normal User Login ### login-1: Normal User Login
&nbsp;
#### Purpose: #### Purpose:
::Test that users can log in with the proper username or ::Test that users can log in with the proper username or
email address and their password. email address and their password.
@ -70,7 +47,7 @@ test@user@nospam.com, empty}
--- ---
### login-2: Locked-out User Login ### login-2: Locked-out User Login
&nbsp;
#### Purpose: #### Purpose:
::Test that a user who has been locked out by a moderator, cannot ::Test that a user who has been locked out by a moderator, cannot
log in, They should see a message indicating that they were locked log in, They should see a message indicating that they were locked
@ -140,7 +117,7 @@ values are written in set notation, one per line. E.g.:
--- ---
### unique-test-case-id2: Test Case Title ### unique-test-case-id2: Test Case Title
&nbsp;
#### Purpose: #### Purpose:
::Short sentence or two about the aspect of the system is ::Short sentence or two about the aspect of the system is
being tested. If this gets too long, break the test case being tested. If this gets too long, break the test case
@ -219,7 +196,7 @@ values are written in set notation, one per line. E.g.:
--- ---
### unique-test-case-id4: Test Case Title ### unique-test-case-id4: Test Case Title
&nbsp;
#### Purpose: #### Purpose:
::Short sentence or two about the aspect of the system is ::Short sentence or two about the aspect of the system is
being tested. If this gets too long, break the test case being tested. If this gets too long, break the test case
@ -298,7 +275,7 @@ values are written in set notation, one per line. E.g.:
--- ---
### unique-test-case-id6: Test Case Title ### unique-test-case-id6: Test Case Title
&nbsp;
#### Purpose: #### Purpose:
::Short sentence or two about the aspect of the system is ::Short sentence or two about the aspect of the system is
being tested. If this gets too long, break the test case being tested. If this gets too long, break the test case
@ -335,23 +312,3 @@ values are written in set notation, one per line. E.g.:
#### Notes and Questions: #### Notes and Questions:
- ::NOTE - ::NOTE
- ::QUESTION - ::QUESTION
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

81
Test-Run-Suite.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# [QA Plan](qa-plan.html) > Test Run Suite
---
##### Project: ##### Project:
::[PROJECTNAME](Home) ::[PROJECTNAME](Home)
@ -29,6 +5,7 @@
::X.Y.Z ::X.Y.Z
##### Related Documents: ##### Related Documents:
- [QA Plan](QA-Plan) > Test Run Suite
- [Test suite](Test-Suite) - [Test suite](Test-Suite)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -43,13 +20,13 @@ assess risk, and focus ongoing testing efforts.
*TODO: *TODO:
- Review the [target audience](Target-and-Benefits), - Review the [target audience](Target-and-Benefits),
[environmental requirements](srs.html#environmental), and [possible [environmental requirements](SRS#environmental), and [possible
deployments](design-architecture.html#deployment) to understand the deployments](Design-Architecturel#deployment) to understand the
set of possible system configurations that could be tested. set of possible system configurations that could be tested.
- Use a table or list to describe that set of possible configurations. - Use a table or list to describe that set of possible configurations.
Mark each possibility with Pending, N/A, or Waived. Mark each possibility with Pending, N/A, or Waived.
- Track each test run with an issue in the issue tracker or an item in - Track each test run with an issue in the issue tracker or an item in
the [test-runs](test-runs.html) document. the [test-runs](Test-Runs) document.
- Periodically review the set of possible system configurations to - Periodically review the set of possible system configurations to
identify any additional needed test runs.* identify any additional needed test runs.*
@ -57,9 +34,9 @@ assess risk, and focus ongoing testing efforts.
| OS \ Browser | IE | Firefox | Safari | Chrome | other | | OS \ Browser | IE | Firefox | Safari | Chrome | other |
|----------------|------------------------------------------|----------------------------------|----------------------------------|-----------|---------| |----------------|------------------------------------------|----------------------------------|----------------------------------|-----------|---------|
| ::Windows | ::[Passed](test-runs.html#TR-01) | ::[Passed](test-runs.html#TR-02) | ::N/A | ::Pending | ::N/A | | ::Windows | ::[Passed](Test-Runs#TR-01) | ::[Passed](Test-Runs#TR-02) | ::N/A | ::Pending | ::N/A |
| ::Linux | ::N/A | ::[Passed](test-runs.html#TR-03) | ::Pending | ::Pending | ::N/A | | ::Linux | ::N/A | ::[Passed](Test-Runs#TR-03) | ::Pending | ::Pending | ::N/A |
| ::Mac | ::[FAILED](test-runs.html#TR-10) | ::Pending | ::[Passed](test-runs.html#TR-11) | ::Pending | ::N/A | | ::Mac | ::[FAILED](Test-Runs#TR-10) | ::Pending | ::[Passed](Test-Runs#TR-11) | ::Pending | ::N/A |
| ::iOS | ::N/A | ::N/A | ::Pending | ::N/A | ::N/A | | ::iOS | ::N/A | ::N/A | ::Pending | ::N/A | ::N/A |
| ::Android | ::N/A | ::N/A | ::Pending | ::Pending | ::N/A | | ::Android | ::N/A | ::N/A | ::Pending | ::Pending | ::N/A |
@ -69,10 +46,10 @@ assess risk, and focus ongoing testing efforts.
applications. Each locale indicates a native language as well as formats applications. Each locale indicates a native language as well as formats
for presenting money, dates, times, etc.* for presenting money, dates, times, etc.*
- ::English US: [Passed](test-runs.html#TR-00) - ::English US: [Passed](Test-Runs#TR-00)
- ::English UK: [Passed](test-runs.html#TR-01) - ::English UK: [Passed](Test-Runs#TR-01)
- ::English CA: [Passed](test-runs.html#TR-02) - ::English CA: [Passed](Test-Runs#TR-02)
- ::Japanese: [Passed](test-runs.html#TR-10) - ::Japanese: [Passed](Test-Runs#TR-10)
- ::Spanish: Pending - ::Spanish: Pending
- ::Russian: Pending - ::Russian: Pending
- ::German: Pending - ::German: Pending
@ -89,34 +66,12 @@ might depend on memory or other hardware specs.*
- ::PCs - ::PCs
- ::IDE drive: Pending - ::IDE drive: Pending
- ::EIDE drive: Waived because we only use IDE features - ::EIDE drive: Waived because we only use IDE features
- ::ATA drive: [Passed](test-runs.html#TR-00) - ::ATA drive: [Passed](Test-Runs#TR-00)
- ::SCSI drive: [Passed](test-runs.html#TR-01) - ::SCSI drive: [Passed](Test-Runs#TR-01)
- ::SATA drive: [Passed](test-runs.html#TR-02) - ::SATA drive: [Passed](Test-Runs#TR-02)
- ::USB drive: [FAILED](test-runs.html#TR-03) - ::USB drive: [FAILED](Test-Runs#TR-03)
- ::Macs - ::Macs
- ::EIDE drive: [Passed](test-runs.html#TR-10) - ::EIDE drive: [Passed](Test-Runs#TR-10)
- ::SCSI drive: [Passed](test-runs.html#TR-11) - ::SCSI drive: [Passed](Test-Runs#TR-11)
- ::Firewire drive: Pending - ::Firewire drive: Pending
- ::USB drive: [FAILED](test-runs.html#TR-12) - ::USB drive: [FAILED](Test-Runs#TR-12)
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

66
Test-Runs.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# [QA Plan](qa-plan.html) > [Test Run Suite](Test-Run-Suite) > Test Runs
---
##### Project: ##### Project:
::[PROJECTNAME](Home) ::[PROJECTNAME](Home)
@ -29,6 +5,7 @@
::X.Y.Z ::X.Y.Z
##### Related Documents: ##### Related Documents:
- [QA Plan](QA-Plan) > [Test Run Suite](Test-Run-Suite) > Test Runs
- [Test suit](Test-Suite) - [Test suit](Test-Suite)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -53,7 +30,7 @@ issue tracking tool to plan and track test runs.*
**Test Description** **Test Description**
::Performed all [manual system tests](test-cases). ::Performed all [manual system tests](Test-Cases).
**Test Run Results:** **Test Run Results:**
@ -81,7 +58,7 @@ issue tracking tool to plan and track test runs.*
**Test Description** **Test Description**
::Performed all [manual system tests](test-cases). ::Performed all [manual system tests](Test-Cases).
**Test Run Results:** **Test Run Results:**
@ -109,7 +86,7 @@ issue tracking tool to plan and track test runs.*
**Test Description** **Test Description**
::Performed all [manual system tests](test-cases). ::Performed all [manual system tests](Test-Cases).
**Test Run Results:** **Test Run Results:**
@ -137,7 +114,7 @@ issue tracking tool to plan and track test runs.*
**Test Description** **Test Description**
::Performed all [manual system tests](test-cases). ::Performed all [manual system tests](Test-Cases).
**Test Run Results:** **Test Run Results:**
@ -165,7 +142,7 @@ issue tracking tool to plan and track test runs.*
**Test Description** **Test Description**
::Performed all [manual system tests](test-cases). ::Performed all [manual system tests](Test-Cases).
**Test Run Results:** **Test Run Results:**
@ -193,7 +170,7 @@ issue tracking tool to plan and track test runs.*
**Test Description** **Test Description**
::Performed all [manual system tests](test-cases). ::Performed all [manual system tests](Test-Cases).
**Test Run Results:** **Test Run Results:**
@ -221,7 +198,7 @@ issue tracking tool to plan and track test runs.*
**Test Description** **Test Description**
::Performed all [manual system tests](test-cases). ::Performed all [manual system tests](Test-Cases).
**Test Run Results:** **Test Run Results:**
@ -249,7 +226,7 @@ issue tracking tool to plan and track test runs.*
**Test Description** **Test Description**
::Performed all [manual system tests](test-cases). ::Performed all [manual system tests](Test-Cases).
**Test Run Results:** **Test Run Results:**
@ -277,7 +254,7 @@ issue tracking tool to plan and track test runs.*
**Test Description** **Test Description**
::Performed all [manual system tests](test-cases). ::Performed all [manual system tests](Test-Cases).
**Test Run Results:** **Test Run Results:**
@ -305,7 +282,7 @@ issue tracking tool to plan and track test runs.*
**Test Description** **Test Description**
::Performed all [manual system tests](test-cases). ::Performed all [manual system tests](Test-Cases).
**Test Run Results:** **Test Run Results:**
@ -316,24 +293,3 @@ issue tracking tool to plan and track test runs.*
- ::NOTE - ::NOTE
- ::QUESTION - ::QUESTION
--- ---
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

160
Test-Suite.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# [QA Plan](qa-plan.html) > Test Suite
---
##### Project: ##### Project:
::[PROJECTNAME](Home) ::[PROJECTNAME](Home)
@ -29,13 +5,14 @@
::X.Y.Z ::X.Y.Z
##### Related Documents: ##### Related Documents:
- [Test case format](test-case-format.html) - [QA Plan](QA-Plan) > Test Suite
- [Test case format](Test-Case-Format)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
--- ---
**Process impact:** This is a test suite for manual system testing. It **Process impact:** This is a test suite for manual system testing. It
is just one activity in the overall [QA plan](qa-plan.). A test case is just one activity in the overall [QA plan](QA-Plan). A test case
suite is simply a table of contents for the individual test cases. suite is simply a table of contents for the individual test cases.
Organizing the suite of test cases by priority, functional area, actor, Organizing the suite of test cases by priority, functional area, actor,
business object, or release can help identify parts of the system that business object, or release can help identify parts of the system that
@ -46,7 +23,7 @@ think you will need. Organize them in a way that will purposely leave
visible blanks on this page if you are missing use cases. Choose one or visible blanks on this page if you are missing use cases. Choose one or
more of the organizations show below.* more of the organizations show below.*
*TIP: Refer back to your [use cases](use-cases.html) document. Use them *TIP: Refer back to your [use cases](Use-Cases) document. Use them
for ideas and make sure that you cover all of them. Remember that test for ideas and make sure that you cover all of them. Remember that test
cases are more precise than use cases, test cases should reference cases are more precise than use cases, test cases should reference
specific details of your implementation, and there may be several test specific details of your implementation, and there may be several test
@ -67,18 +44,18 @@ done for the enrollment feature below.*
| BO \ Action | ::add | ::list/browse | ::edit | ::delete | ::search | ::other | | BO \ Action | ::add | ::list/browse | ::edit | ::delete | ::search | ::other |
|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| |---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| ::Student | <ul><li>::[student-add-1](test-cases.html#student-add-1)</li><li>::[student-add-2](test-cases.html#student-add-2)</li><li>::[student-add-3](test-cases.html#student-add-3)</li></ul> | ::[student-list-1](test-cases.html#student-list-1) | <ul><li>::[student-edit-1](test-cases.html#student-edit-1)</li><li>::[student-edit-2](test-cases.html#student-edit-2)</li></ul> | ::[student-delete-1](test-casesstudent-delete-1) | <ul><li>::[student-search-1](test-cases.html#student-search-1)</li><li>::[student-search-2](test-cases.html#student-search-2)</li></ul> | ::[See grid below](#enroll-grid) | | ::Student | <ul><li>::[student-add-1](Test-Cases#student-add-1)</li><li>::[student-add-2](Test-Cases#student-add-2)</li><li>::[student-add-3](Test-Cases#student-add-3)</li></ul> | ::[student-list-1](Test-Cases#student-list-1) | <ul><li>::[student-edit-1](Test-Cases#student-edit-1)</li><li>::[student-edit-2](Test-Cases#student-edit-2)</li></ul> | ::[student-delete-1](test-casesstudent-delete-1) | <ul><li>::[student-search-1](Test-Cases#student-search-1)</li><li>::[student-search-2](Test-Cases#student-search-2)</li></ul> | ::[See grid below](#enroll-grid) |
| ::Course | <ul><li>::[course-add-1](test-cases.html#course-add-1)</li><li>::[course-add-2](test-cases.html#course-add-2)</li></ul> | ::[course-list-1](test-cases.html#course-list-1) | <ul><li>::[course-edit-1](test-cases.html#course-edit-1)</li><li>::[course-move-1](test-cases.html#course-move-1)</li><li>::[course-add-prereq-1](test-cases.html#course-add-prereq-1)</li></ul> | ::[course-cancel-1](test-cases.html#course-cancel-1) | ::[course-search-1](test-cases.html#course-search-1) | ::N/A | | ::Course | <ul><li>::[course-add-1](Test-Cases#course-add-1)</li><li>::[course-add-2](Test-Cases#course-add-2)</li></ul> | ::[course-list-1](Test-Cases#course-list-1) | <ul><li>::[course-edit-1](Test-Cases#course-edit-1)</li><li>::[course-move-1](Test-Cases#course-move-1)</li><li>::[course-add-prereq-1](Test-Cases#course-add-prereq-1)</li></ul> | ::[course-cancel-1](Test-Cases#course-cancel-1) | ::[course-search-1](Test-Cases#course-search-1) | ::N/A |
| ::Room | <ul><li>::[room-add-1](test-cases.html#room-add-1)</li><li>::[room-add-2](test-cases.html#room-add-2)</li></ul> | ::[room-list-1](test-cases.html#room-list-1) | ::TODO | ::TODO | ::TODO | ::N/A | | ::Room | <ul><li>::[room-add-1](Test-Cases#room-add-1)</li><li>::[room-add-2](Test-Cases#room-add-2)</li></ul> | ::[room-list-1](Test-Cases#room-list-1) | ::TODO | ::TODO | ::TODO | ::N/A |
| ::Instructor | ::[inst-add-1](test-cases.html#inst-add-1) | ::N/A | ::[inst-edit-1](test-cases.html#inst-edit-1) | ::[inst-delete-1](test-cases.html#inst-delete-1) | ::N/A | <ul><li>::[inst-eval-1](test-cases.html#inst-eval-1)</li><li>::[inst-eval-2](test-cases.html#inst-eval-2)</li></ul> | | ::Instructor | ::[inst-add-1](Test-Cases#inst-add-1) | ::N/A | ::[inst-edit-1](Test-Cases#inst-edit-1) | ::[inst-delete-1](Test-Cases#inst-delete-1) | ::N/A | <ul><li>::[inst-eval-1](Test-Cases#inst-eval-1)</li><li>::[inst-eval-2](Test-Cases#inst-eval-2)</li></ul> |
### ::Test Cases for Enrolling in Courses ### ::Test Cases for Enrolling in Courses
| ::Course \ Student | ::New Freshman | ::Senior | ::Any Honors | ::Other | | ::Course \ Student | ::New Freshman | ::Senior | ::Any Honors | ::Other |
|--------------------|----------------------------------------------------------|----------------------------------------------------------|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| |--------------------|----------------------------------------------------------|----------------------------------------------------------|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| ::In Major | [::enroll-priority-2](test-cases.html#enroll-priority-2) | [::enroll-priority-1](test-cases.html#enroll-priority-1) | [::enroll-priority-1](test-cases.html#enroll-priority-1) | <ul><li>[::enroll-1](test-cases.html#enroll-1)</li><li>[::enroll-2](test-cases.html#enroll-2)</li><li>[::enroll-3](test-cases.html#enroll-3)</li></ul> | | ::In Major | [::enroll-priority-2](Test-Cases#enroll-priority-2) | [::enroll-priority-1](Test-Cases#enroll-priority-1) | [::enroll-priority-1](Test-Cases#enroll-priority-1) | <ul><li>[::enroll-1](Test-Cases#enroll-1)</li><li>[::enroll-2](Test-Cases#enroll-2)</li><li>[::enroll-3](Test-Cases#enroll-3)</li></ul> |
| ::Non-Major | [::enroll-priority-2](test-cases.html#enroll-priority-2) | [::enroll-priority-1](test-cases.html#enroll-priority-1) | [::enroll-priority-1](test-cases.html#enroll-priority-1) | <ul><li>[::enroll-1](test-cases.html#enroll-1)</li><li>[::enroll-2](test-cases.html#enroll-2)</li><li>[::enroll-3](test-cases.html#enroll-3)</li></ul> | | ::Non-Major | [::enroll-priority-2](Test-Cases#enroll-priority-2) | [::enroll-priority-1](Test-Cases#enroll-priority-1) | [::enroll-priority-1](Test-Cases#enroll-priority-1) | <ul><li>[::enroll-1](Test-Cases#enroll-1)</li><li>[::enroll-2](Test-Cases#enroll-2)</li><li>[::enroll-3](Test-Cases#enroll-3)</li></ul> |
| ::Honors Course | [::enroll-priority-1](test-cases.html#enroll-priority-1) | [::enroll-priority-1](test-cases.html#enroll-priority-1) | [::enroll-priority-1](test-cases.html#enroll-priority-1) | [::enroll-restricted-1](test-cases.html#enroll-restricted-1) | | ::Honors Course | [::enroll-priority-1](Test-Cases#enroll-priority-1) | [::enroll-priority-1](Test-Cases#enroll-priority-1) | [::enroll-priority-1](Test-Cases#enroll-priority-1) | [::enroll-restricted-1](Test-Cases#enroll-restricted-1) |
### Test Cases by Feature Priority ### Test Cases by Feature Priority
@ -89,28 +66,28 @@ with "TODO".*
- Essential - Essential
- ::[F-01](features#F-01): - ::[F-01](features#F-01):
::[student-add-1](test-cases.html#student-add-1) ::[student-add-1](Test-Cases#student-add-1)
::[student-add-2](test-cases.html#student-add-2) ::[student-add-2](Test-Cases#student-add-2)
::[student-add-3](test-cases.html#student-add-3) ::[student-add-3](Test-Cases#student-add-3)
- ::[F-02](features#F-02): [enroll-1](test-cases.html#enroll-1) - ::[F-02](features#F-02): [enroll-1](Test-Cases#enroll-1)
::[enroll-2](test-cases.html#enroll-2) ::[enroll-2](Test-Cases#enroll-2)
::[enroll-3](test-cases.html#enroll-3) ::[enroll-3](Test-Cases#enroll-3)
::[enroll-priority-1](test-cases.html#enroll-priority-1) ::[enroll-priority-1](Test-Cases#enroll-priority-1)
::[enroll-priority-2](test-cases.html#enroll-priority-2) ::[enroll-priority-2](Test-Cases#enroll-priority-2)
::[enroll-restricted-1](test-cases.html#enroll-restricted-1) ::[enroll-restricted-1](Test-Cases#enroll-restricted-1)
- Expected - Expected
- ::[F-22](features#F-22): - ::[F-22](features#F-22):
::[student-search-1](test-cases.html#student-search-1) ::[student-search-1](Test-Cases#student-search-1)
::[student-search-2](test-cases.html#student-search-2) ::[student-search-2](Test-Cases#student-search-2)
::[course-search-1](test-cases.html#course-search-1) ::[course-search-1](Test-Cases#course-search-1)
- ::[F-23](features#F-23): - ::[F-23](features#F-23):
::[room-add-1](test-cases.html#room-add-1) ::[room-add-1](Test-Cases#room-add-1)
::[room-add-2](test-cases.html#room-add-2) ::[room-add-2](Test-Cases#room-add-2)
::[room-edit-1](test-cases.html#room-edit-1) TODO ::[room-edit-1](Test-Cases#room-edit-1) TODO
- Desired - Desired
- ::[F-31](features#F-31): - ::[F-31](features#F-31):
::[inst-eval-1](test-cases.html#inst-eval-1) ::[inst-eval-1](Test-Cases#inst-eval-1)
::[inst-eval-2](test-cases.html#inst-eval-2) ::[inst-eval-2](Test-Cases#inst-eval-2)
### Test Cases by Use Case Priority ### Test Cases by Use Case Priority
@ -120,56 +97,35 @@ cases for each use case. If a use case needs more test cases, note that
with "TODO".* with "TODO".*
- Essential - Essential
- ::[UC-01](use-cases#UC-01) - ::[UC-01](Use-Cases#UC-01)
- ::[student-add-1](test-cases.html#student-add-1) - ::[student-add-1](Test-Cases#student-add-1)
- ::[student-add-2](test-cases.html#student-add-2) - ::[student-add-2](Test-Cases#student-add-2)
- ::[student-add-3](test-cases.html#student-add-3) - ::[student-add-3](Test-Cases#student-add-3)
- ::[UC-02](use-cases#UC-02) - ::[UC-02](Use-Cases#UC-02)
- ::[enroll-1](test-cases.html#enroll-1) - ::[enroll-1](Test-Cases#enroll-1)
- ::[UC-03](use-cases#UC-03) - ::[UC-03](Use-Cases#UC-03)
- ::[enroll-2](test-cases.html#enroll-2) - ::[enroll-2](Test-Cases#enroll-2)
- ::[UC-04](use-cases#UC-04) - ::[UC-04](Use-Cases#UC-04)
- ::[enroll-3](test-cases.html#enroll-3) - ::[enroll-3](Test-Cases#enroll-3)
- ::[UC-05](use-cases#UC-05) - ::[UC-05](Use-Cases#UC-05)
- ::[enroll-priority-1](test-cases.html#enroll-priority-1) - ::[enroll-priority-1](Test-Cases#enroll-priority-1)
- ::[enroll-priority-2](test-cases.html#enroll-priority-2) - ::[enroll-priority-2](Test-Cases#enroll-priority-2)
- ::[UC-06](use-cases#UC-06) - ::[UC-06](Use-Cases#UC-06)
- ::[enroll-restricted-1](test-cases.html#enroll-restricted-1) - ::[enroll-restricted-1](Test-Cases#enroll-restricted-1)
- Expected - Expected
- ::[UC-22](use-cases#UC-22): - ::[UC-22](Use-Cases#UC-22):
::[student-search-1](test-cases.html#student-search-1) ::[student-search-1](Test-Cases#student-search-1)
::[student-search-2](test-cases.html#student-search-2) ::[student-search-2](Test-Cases#student-search-2)
- ::[UC-23](use-cases#UC-23): - ::[UC-23](Use-Cases#UC-23):
::[course-search-1](test-cases.html#course-search-1) ::[course-search-1](Test-Cases#course-search-1)
- ::[UC-30](use-cases#UC-30): - ::[UC-30](Use-Cases#UC-30):
::[room-add-1](test-cases.html#room-add-1) ::[room-add-1](Test-Cases#room-add-1)
::[room-add-2](test-cases.html#room-add-2) ::[room-add-2](Test-Cases#room-add-2)
- ::[UC-31](use-cases#UC-31): - ::[UC-31](Use-Cases#UC-31):
::[room-edit-1](test-cases.html#room-edit-1) TODO ::[room-edit-1](Test-Cases#room-edit-1) TODO
- ::[UC-32](use-cases#UC-32): TODO - ::[UC-32](Use-Cases#UC-32): TODO
- ::[UC-33](use-cases#UC-33): TODO - ::[UC-33](Use-Cases#UC-33): TODO
- Desired - Desired
- ::[UC-40](use-cases#UC-40): - ::[UC-40](Use-Cases#UC-40):
::[inst-eval-1](test-cases.html#inst-eval-1) ::[inst-eval-1](Test-Cases#inst-eval-1)
::[inst-eval-2](test-cases.html#inst-eval-2) ::[inst-eval-2](Test-Cases#inst-eval-2)
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

52
Use-Case-Format.md
View File

@ -1,33 +1,14 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;"> ##### Related Documents
<item><a href="index.html">Overview</a></item> - [SRS](SRS) > [Use Case Suite](Use-Case-Suite) > Use Case Format
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# [SRS](SRS) > [Use Case Suite](Use-Case-Suite) > Use Case Format
--- ---
**Process impact:** This reference page documents the format of use **Process impact:** This reference page documents the format of use
cases and gives tips on writing use cases. You can copy and paste the cases and gives tips on writing use cases. You can copy and paste the
sample use case into your [Use Cases](use-cases) document. This sample use case into your [Use Cases](Use-Cases) document. This
file itself should not be edited to hold specific use cases. file itself should not be edited to hold specific use cases.
*TODO: Use this template once in your [Use Cases](use-cases) *TODO: Use this template once in your [Use Cases](Use-Cases)
document. Anything you mention here will apply to all use cases in that document. Anything you mention here will apply to all use cases in that
file.* file.*
@ -48,7 +29,7 @@ file.*
*TODO: Copy and paste this use case template as many times as needed in *TODO: Copy and paste this use case template as many times as needed in
your [Use Cases](use-cases.html) document. Only use those fields that your [Use Cases](Use-Cases) document. Only use those fields that
are not the same as the default for all use cases.* are not the same as the default for all use cases.*
--- ---
@ -144,30 +125,9 @@ This is like a subroutine call. The user will do all the steps of
the named use case and then continue on with the next step of this the named use case and then continue on with the next step of this
use case. use case.
### Further Information {#further-information} ### Further Information
For more information on advice, see: For more information on advice, see:
- Words of wisdom on [use case suites](http://readyset.tigris.org/words-of-wisdom/use-case-suite.html). - Words of wisdom on [use case suites](http://readyset.tigris.org/words-of-wisdom/use-case-suite.html).
- Words of wisdom on [use cases](http://readyset.tigris.org/words-of-wisdom/use-cases.html). - Words of wisdom on [use cases](http://readyset.tigris.org/words-of-wisdom/use-cases.html).
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

172
Use-Case-Suite.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# [SRS](SRS) > Use Case Suite
---
##### Project: ##### Project:
::[PROJECTNAME](Home) ::[PROJECTNAME](Home)
@ -29,9 +5,10 @@
::X.Y.Z ::X.Y.Z
##### Related Documents: ##### Related Documents:
- [Project proposal](proposal) > [User needs](User-Needs) - [SRS](SRS) > Use Case Suite
- [SRS](SRS) > [Feature set](feature-set) - [Project proposal](Proposal) > [User needs](User-Needs)
- [Use case format](use-case-format) - [SRS](SRS) > [Feature set](Feature-Set)
- [Use case format](Use-Case-Format)
- ::LINK TO USE CASE DIAGRAM - ::LINK TO USE CASE DIAGRAM
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -49,10 +26,10 @@ visible blanks on this page if you are missing use cases. E.g., see
"Scalability and availability". Choose one or more of the organizations "Scalability and availability". Choose one or more of the organizations
show below.* show below.*
*TIP: Refer back to the user stories in your [user *TIP: Refer back to the user stories in your [user needs](User-Needs)
needs](User-Needs) document. Use them for ideas and make sure that document. Use them for ideas and make sure that you cover all of them.
you cover all of them. Remember that use cases are more precise than Remember that use cases are more precise than user stories, and there
user stories, and there may be several use cases for a given user story.* may be several use cases for a given user story.*
*TIP: The use case suite can be organized into nested lists according to *TIP: The use case suite can be organized into nested lists according to
other coverage criteria, e.g., by actor. Or, it can be organized into other coverage criteria, e.g., by actor. Or, it can be organized into
@ -63,35 +40,35 @@ cases, explicitly mark it "N/A". Otherwise, mark it "TODO".*
### Use Cases by Functional Area ### Use Cases by Functional Area
- ::User account management - ::User account management
- ::[UC-00](use-cases#UC-00) Configure the site - ::[UC-00](Use-Cases#UC-00) Configure the site
- ::[UC-01](use-cases#UC-01) Register as a new user - ::[UC-01](Use-Cases#UC-01) Register as a new user
- ::[UC-02](use-cases#UC-02) Request new password - ::[UC-02](Use-Cases#UC-02) Request new password
- ::[UC-03](use-cases#UC-03) Edit user profile - ::[UC-03](Use-Cases#UC-03) Edit user profile
- ::[UC-04](use-cases#UC-04) View user profile - ::[UC-04](Use-Cases#UC-04) View user profile
- ::Course management - ::Course management
- ::[UC-10](use-cases#UC-10) Create course - ::[UC-10](Use-Cases#UC-10) Create course
- ::[UC-11](use-cases#UC-11) View catalog description - ::[UC-11](Use-Cases#UC-11) View catalog description
- ::[UC-31](use-cases#UC-31) Assign course to room - ::[UC-31](Use-Cases#UC-31) Assign course to room
- ::Course enrollment - ::Course enrollment
- ::[UC-20](use-cases#UC-20) Enroll in course - ::[UC-20](Use-Cases#UC-20) Enroll in course
- ::[UC-21](use-cases#UC-21) Drop course - ::[UC-21](Use-Cases#UC-21) Drop course
- ::Scalability and availability - ::Scalability and availability
- ::N/A: These features are completely automated and internal, users - ::N/A: These features are completely automated and internal, users
never interact with them never interact with them
- ::Facilities management - ::Facilities management
- ::[UC-30](use-cases#UC-30) View room description - ::[UC-30](Use-Cases#UC-30) View room description
- ::[UC-31](use-cases#UC-31) Assign course to room - ::[UC-31](Use-Cases#UC-31) Assign course to room
- ::Grading and transcripts - ::Grading and transcripts
- ::TODO: need to write use cases here - ::TODO: need to write use cases here
- ::FUNCTIONAL AREA SEVEN - ::FUNCTIONAL AREA SEVEN
- ::[UC-70](use-cases#UC-70) NAME OF USE CASE - ::[UC-70](Use-Cases#UC-70) NAME OF USE CASE
- ::[UC-71](use-cases#UC-71) NAME OF USE CASE - ::[UC-71](Use-Cases#UC-71) NAME OF USE CASE
- ::FUNCTIONAL AREA EIGHT - ::FUNCTIONAL AREA EIGHT
- ::[UC-80](use-cases#UC-80) NAME OF USE CASE - ::[UC-80](Use-Cases#UC-80) NAME OF USE CASE
- ::[UC-81](use-cases#UC-81) NAME OF USE CASE - ::[UC-81](Use-Cases#UC-81) NAME OF USE CASE
- ::FUNCTIONAL AREA NINE - ::FUNCTIONAL AREA NINE
- ::[UC-90](use-cases#UC-90) NAME OF USE CASE - ::[UC-90](Use-Cases#UC-90) NAME OF USE CASE
- ::[UC-91](use-cases#UC-91) NAME OF USE CASE - ::[UC-91](Use-Cases#UC-91) NAME OF USE CASE
### Use Cases by Stakeholder ### Use Cases by Stakeholder
@ -100,59 +77,59 @@ but it is shown here as a list or table so that missing use cases are
more noticeable. more noticeable.
- ::All Stakeholders - ::All Stakeholders
- ::[UC-11](use-cases#UC-11) View catalog description - ::[UC-11](Use-Cases#UC-11) View catalog description
- ::[UC-30](use-cases#UC-30) View room description - ::[UC-30](Use-Cases#UC-30) View room description
- ::Students - ::Students
- ::[UC-01](use-cases#UC-01) Register as a new user - ::[UC-01](Use-Cases#UC-01) Register as a new user
- ::[UC-02](use-cases#UC-02) Request new password - ::[UC-02](Use-Cases#UC-02) Request new password
- ::[UC-03](use-cases#UC-03) Edit user profile - ::[UC-03](Use-Cases#UC-03) Edit user profile
- ::[UC-20](use-cases#UC-20) Enroll in course - ::[UC-20](Use-Cases#UC-20) Enroll in course
- ::[UC-21](use-cases#UC-21) Drop course - ::[UC-21](Use-Cases#UC-21) Drop course
- ::Instructors - ::Instructors
- ::[UC-04](use-cases#UC-04) View user profile - ::[UC-04](Use-Cases#UC-04) View user profile
- ::Administrators - ::Administrators
- ::[UC-00](use-cases#UC-00) Configure the site - ::[UC-00](Use-Cases#UC-00) Configure the site
- ::[UC-10](use-cases#UC-10) Create course - ::[UC-10](Use-Cases#UC-10) Create course
- ::[UC-31](use-cases#UC-31) Assign course to room - ::[UC-31](Use-Cases#UC-31) Assign course to room
- ::Executives - ::Executives
- ::N/A: this stakeholder never directly interacts with the system - ::N/A: this stakeholder never directly interacts with the system
- ::Vendors - ::Vendors
- ::TODO: need to write use cases here - ::TODO: need to write use cases here
- ::STAKEHOLDER - ::STAKEHOLDER
- ::[UC-70](use-cases#UC-70) NAME OF USE CASE - ::[UC-70](Use-Cases#UC-70) NAME OF USE CASE
- ::[UC-71](use-cases#UC-71) NAME OF USE CASE - ::[UC-71](Use-Cases#UC-71) NAME OF USE CASE
- ::STAKEHOLDER - ::STAKEHOLDER
- ::[UC-80](use-cases#UC-80) NAME OF USE CASE - ::[UC-80](Use-Cases#UC-80) NAME OF USE CASE
- ::[UC-81](use-cases#UC-81) NAME OF USE CASE - ::[UC-81](Use-Cases#UC-81) NAME OF USE CASE
- ::STAKEHOLDER - ::STAKEHOLDER
- ::[UC-90](use-cases#UC-90) NAME OF USE CASE - ::[UC-90](Use-Cases#UC-90) NAME OF USE CASE
- ::[UC-91](use-cases#UC-91) NAME OF USE CASE - ::[UC-91](Use-Cases#UC-91) NAME OF USE CASE
### Use Cases by Priority ### Use Cases by Priority
- Essential - Essential
- ::[UC-00](use-cases#UC-00) Configure the site - ::[UC-00](Use-Cases#UC-00) Configure the site
- ::[UC-01](use-cases#UC-01) Register as a new user - ::[UC-01](Use-Cases#UC-01) Register as a new user
- ::[UC-10](use-cases#UC-10) Create course - ::[UC-10](Use-Cases#UC-10) Create course
- ::[UC-11](use-cases#UC-11) View catalog description - ::[UC-11](Use-Cases#UC-11) View catalog description
- ::[UC-20](use-cases#UC-20) Enroll in course - ::[UC-20](Use-Cases#UC-20) Enroll in course
- ::[UC-21](use-cases#UC-21) Drop course - ::[UC-21](Use-Cases#UC-21) Drop course
- ::[UC-30](use-cases#UC-30) Assign course to room - ::[UC-30](Use-Cases#UC-30) Assign course to room
- ::[UC-31](use-cases#UC-31) Assign course to room - ::[UC-31](Use-Cases#UC-31) Assign course to room
- Expected - Expected
- ::[UC-02](use-cases#UC-02) Request new password - ::[UC-02](Use-Cases#UC-02) Request new password
- ::[UC-03](use-cases#UC-03) Edit user profile - ::[UC-03](Use-Cases#UC-03) Edit user profile
- ::[UC-04](use-cases#UC-04) View user profile - ::[UC-04](Use-Cases#UC-04) View user profile
- ::[UC-70](use-cases#UC-70) NAME OF USE CASE - ::[UC-70](Use-Cases#UC-70) NAME OF USE CASE
- ::[UC-71](use-cases#UC-71) NAME OF USE CASE - ::[UC-71](Use-Cases#UC-71) NAME OF USE CASE
- ::[UC-80](use-cases#UC-80) NAME OF USE CASE - ::[UC-80](Use-Cases#UC-80) NAME OF USE CASE
- ::[UC-81](use-cases#UC-81) NAME OF USE CASE - ::[UC-81](Use-Cases#UC-81) NAME OF USE CASE
- Desired - Desired
- ::N/A: There are no use cases with Priority = Desired - ::N/A: There are no use cases with Priority = Desired
- Optional - Optional
- ::[UC-30](use-cases#UC-30) View room description - ::[UC-30](Use-Cases#UC-30) View room description
- ::[UC-90](use-cases#UC-90) NAME OF USE CASE - ::[UC-90](Use-Cases#UC-90) NAME OF USE CASE
- ::[UC-91](use-cases#UC-91) NAME OF USE CASE - ::[UC-91](Use-Cases#UC-91) NAME OF USE CASE
### Use Cases by Business Object and Actor ### Use Cases by Business Object and Actor
@ -160,27 +137,6 @@ more noticeable.
| BO \ Actor | All | ::Student | ::Instructor | ::Admin | | BO \ Actor | All | ::Student | ::Instructor | ::Admin |
|--------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|-----------------------------------------------------------------------------------------------| |--------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|-----------------------------------------------------------------------------------------------|
| ::Student record | ::N/A | <ul><li>::[Register as new user](use-cases#uc-01)</li><li>::[Request new password](use-cases#uc-02)</li><li>::[Edit user profile](use-cases#uc-03)</li></ul> | ::[View user profile](use-cases#uc-04) | ::N/A | | ::Student record | ::N/A | <ul><li>::[Register as new user](Use-Cases#uc-01)</li><li>::[Request new password](Use-Cases#uc-02)</li><li>::[Edit user profile](Use-Cases#uc-03)</li></ul> | ::[View user profile](Use-Cases#uc-04) | ::N/A |
| ::Course | ::[View catalog description](use-cases#uc-11) | <ul><li>::[Enroll in course](use-cases#uc-20)</li><li>::[Drop course](use-cases#uc-21)</li></ul> | ::TODO | <ul><li>::[Create course](use-cases#uc-10)</li><li>::[Assign room](use-cases#uc-31)</li></ul> | | ::Course | ::[View catalog description](Use-Cases#uc-11) | <ul><li>::[Enroll in course](Use-Cases#uc-20)</li><li>::[Drop course](Use-Cases#uc-21)</li></ul> | ::TODO | <ul><li>::[Create course](Use-Cases#uc-10)</li><li>::[Assign room](Use-Cases#uc-31)</li></ul> |
| ::Room | ::[View room description](use-cases#uc-30) | ::N/A | ::N/A | ::[Assign room](use-cases#uc-31) | | ::Room | ::[View room description](Use-Cases#uc-30) | ::N/A | ::N/A | ::[Assign room](Use-Cases#uc-31) |
<!-- end markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

51
Use-Cases.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# [SRS](SRS) > [Use Case Suite](Use-Case-Suite) > Use Cases
---
##### Project: ##### Project:
::PROJECTNAME ::PROJECTNAME
@ -29,8 +5,9 @@
::X.Y.Z ::X.Y.Z
##### Related Documents: ##### 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) - [Project proposal](Proposal) > [User needs](User-Needs), [SRS](SRS) > [Feature set](Feature-Set)
- [Use case format](use-case-format) - [Use case format](Use-Case-Format)
- ::LINK TO USE CASE DIAGRAM - ::LINK TO USE CASE DIAGRAM
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -66,7 +43,8 @@ detail.*
actually writing the use case in detail. Document the most important use actually writing the use case in detail. Document the most important use
cases first and come back to less important ones later.* cases first and come back to less important ones later.*
*TIP: See detailed tips in the [guidelines for writing usecases](use-case-format.html#guidelines).* *TIP: See detailed tips in the
[guidelines for writing use cases](Use-Case-Format#further-information).*
--- ---
### UC-00: Configure the site ### UC-00: Configure the site
@ -1209,24 +1187,3 @@ cases first and come back to less important ones later.*
- ::NOTE - ::NOTE
- ::QUESTION - ::QUESTION
- ::QUESTION - ::QUESTION
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

45
User-Guide.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# User Guide
---
*TODO: Fill in information on this product. Make sure to use the *TODO: Fill in information on this product. Make sure to use the
**product** name and **external** release number, not internal **product** name and **external** release number, not internal
information.* information.*
@ -69,24 +45,3 @@ roles, or in other ways.*
- ::SUB-SECTION-NAME - ::SUB-SECTION-NAME
- ::SUB-SECTION-NAME - ::SUB-SECTION-NAME
- ::SUB-SECTION-NAME - ::SUB-SECTION-NAME
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

45
User-Needs.md
View File

@ -1,27 +1,3 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<link type="image/png" href="assets/logo.png" rel="icon">
<title>ReadySet Markdown</title>
</head>
<script src="https://www.w3schools.com/lib/w3data.js"></script>
<body>
<topbar style="display:none;">
<item><a href="index.html">Overview</a></item>
<item><a href="plan.html">Project Plan</a></item>
<item><a href="index-all.html">Workflows</a></item>
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
<toc></toc>
</topbar>
<xmp theme="readable" style="display:none;">
<!-- Markdown content here -->
# User Needs
---
##### Project: ##### Project:
::[PROJECTNAME](Home) ::[PROJECTNAME](Home)
@ -242,24 +218,3 @@ following system capacity:
- ::4 MB max disk space for each clan (average: 0.5 MB) - ::4 MB max disk space for each clan (average: 0.5 MB)
- ::100 game vendors posting advertisements on the site - ::100 game vendors posting advertisements on the site
- ::1000 actual advertisements in the database - ::1000 actual advertisements in the database
<!-- End Markdown content -->
</xmp>
<div w3-include-html="_words-of-wisdom.html"></div>
<div w3-include-html="_footer.html"></div>
<script>
w3IncludeHTML();
</script>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
<!-- Include it AFTER strapdown -->
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
<!-- Include it AFTER EVERYTHING -->
<script src="assets/logo.js"></script>
<script src="assets/themeswitcher.js"></script>
</body>
</html>

2
Workflows.md
View File

@ -119,5 +119,5 @@
### How to download these templates: ### How to download these templates:
- [Download template archive](http://readyset.tigris.org/servlets/ProjectDocumentList), or - [Download template archive](http://readyset.tigris.org/servlets/ProjectDocumentList), or
- Use CVS to [check out](http://readyset.tigris.org/servlets/ProjectSource) project - Use CVS to [check out](http://readyset.tigris.org/servlets/ProjectSource) project
"readyset" or Download from [ReadySet Markdown](https://github.com/bike-bill/readyset-markdown) "readyset" or Download from [ReadySet GFM](https://github.com/bike-bill/readyset-gfm)
on Github. on Github.