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

Fix linter warnings

Browse Source
This commit is contained in:
William Sandner 2021-08-01 15:15:57 +02:00
parent 70a43d171f
commit 704e13c18f
30 changed files with 135 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Installation-Guide.md
View File

@ -1,24 +1,25 @@
<!-- markdownlint-disable-next-line MD041 -->
*TODO: Fill in information about this product. Make sure to use the *TODO: Fill in information about 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.*
##### Product: ##### Product
::PRODUCT-NAME ::PRODUCT-NAME
##### Release Number: ##### Internal Release Number
::X.Y.Z ::X.Y.Z
##### Release Date: ##### Release Date
::YEAR/MONTH/DAY ::YEAR/MONTH/DAY
##### Customer Support: ##### Customer Support
:: For more information or support, please visit our :: For more information or support, please visit our
[website](http://www.COMPANY.com/products/PRODUCT-NAME/) or [website](::http://www.COMPANY.com/products/PRODUCT-NAME/) or
email us at <support@COMPANY.com> email us at <::support@COMPANY.com>
--- ---

1
Interview-Checklist.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Related Documents ##### Related Documents
- [User Needs](User-Needs) - [User Needs](User-Needs)

1
Interview-Notes.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)

5
Legal.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
@ -6,14 +7,14 @@
::X.Y.Z ::X.Y.Z
##### Release Audience: ##### Release Audience
- ::General availability release || - ::General availability release ||
- ::Customer-specific release: CUSTOMER(S) || - ::Customer-specific release: CUSTOMER(S) ||
- ::Developer release (Internal usage only) || - ::Developer release (Internal usage only) ||
- ::Early access release (Controlled external access) - ::Early access release (Controlled external access)
##### Intended Product License: ##### Intended Product License
::Commercial license ::Commercial license

4
License.md
View File

@ -1,4 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
Do not modify or delete this file. This file describes the license under Do not modify or delete this file. This file describes the license under
which you may use the ReadySET templates. which you may use the ReadySET templates.
@ -62,7 +62,7 @@ same license.
No, but it would be very welcome. Even if you don't modify the No, but it would be very welcome. Even if you don't modify the
templates, you can share your "words of wisdom". For more templates, you can share your "words of wisdom". For more
information on contributing, see the information on contributing, see the
[ReadySET home page](http://readyset.tigris.org/). [ReadySET home page](http://readyset.tigris.org/).
#### ReadySET seems too good to be true. What is the catch? Why would anyone buy a commercial version? #### ReadySET seems too good to be true. What is the catch? Why would anyone buy a commercial version?

5
Project-Plan.md
View File

@ -1,12 +1,13 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
##### Project Time-frame: ##### Project Time-frame
::START-DATE - END-DATE ::START-DATE - END-DATE
##### Attached worksheets: ##### Attached worksheets
- Plan > [Resource Needs](Resource-Needs) - Plan > [Resource Needs](Resource-Needs)

17
Proposal.md
View File

@ -1,16 +1,17 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
##### Project Time-frame: ##### Project Time-frame
::2003/1/16 to 2003/3/19 ::2003/1/16 to 2003/3/19
##### Summary: ##### Summary
::2-4 SENTENCE SUMMARY ::2-4 SENTENCE SUMMARY
##### Attached Worksheets: ##### Attached Worksheets
Project Proposal > [Target audience and benefits](Target-and-Benefits) Project Proposal > [Target audience and benefits](Target-and-Benefits)
@ -63,8 +64,8 @@ motivated or honest in their evaluations. There are already some
clan directory web sites, but they are not automated so they are clan directory web sites, but they are not automated so they are
always out of date and do not rate the quality of the websites. always out of date and do not rate the quality of the websites.
- ::[Example of current manually maintained clan website](#) - ::[Example of current manually maintained clan website](#tbd)
- ::[Link to existing competitor](#) - ::[Link to existing competitor](#tbd)
#### Why is this problem worth solving or worth solving better? #### Why is this problem worth solving or worth solving better?
@ -99,9 +100,9 @@ those advantages.
::The following pages provide additional background and motivation: ::The following pages provide additional background and motivation:
- ::[Magazine article on this topic](#) - ::[Magazine article on this topic](#tbd)
- ::[Industry analysis's report on massive-multi-player game market](#) - ::[Industry analysis's report on massive-multi-player game market](#tbd)
- ::[Quotes from game players](#) - ::[Quotes from game players](#tbd)
### Goal ### Goal

17
QA-Plan.md
View File

@ -1,3 +1,6 @@
<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable-next-line MD041 -->
*TODO: For each release, update this file by filling in answers to the *TODO: For each release, update this file by filling in answers to the
questions. In cases where multiple answers are already written, delete questions. In cases where multiple answers are already written, delete
those answers that do not apply.* those answers that do not apply.*
@ -6,18 +9,18 @@ those answers that do not apply.*
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
##### Internal Release Number: ##### Internal Release Number
::X.Y.Z ::X.Y.Z
##### Release Audience: ##### Release Audience
- ::General availability release || - ::General availability release ||
- ::Customer-specific release: CUSTOMER(S) || - ::Customer-specific release: CUSTOMER(S) ||
- ::Developer release (Internal usage only) || - ::Developer release (Internal usage only) ||
- ::Early access release (Controlled external access) - ::Early access release (Controlled external access)
##### Attached Worksheets: ##### Attached Worksheets
- QA plan > [Review meeting notes](Review-Meeting-Notes) - QA plan > [Review meeting notes](Review-Meeting-Notes)
- QA plan > [System test case suite](Test-Suite) - QA plan > [System test case suite](Test-Suite)
@ -67,7 +70,7 @@ coordinate all the QA activities.
#### What is the scope of this QA plan? #### What is the scope of this QA plan?
::All components and aspects of the system will be evaluated in ::All components and aspects of the system will be evaluated in
this release. this release.
::There are many quality goals and approaches to assuring them. Since ::There are many quality goals and approaches to assuring them. Since
@ -141,7 +144,7 @@ achieve. If you do not plan to perform an activity, write "N/A".*
|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ::Preconditions | <ul><li>::Every public method</li><li>::Every public method in COMPONENT-NAME</li><li>::All public methods that modify data</li></ul> | ::We will use if-statements at the beginning of public methods to validate each argument value. This helps to document assumptions and catch invalid values before they can cause faults. | | ::Preconditions | <ul><li>::Every public method</li><li>::Every public method in COMPONENT-NAME</li><li>::All public methods that modify data</li></ul> | ::We will use if-statements at the beginning of public methods to validate each argument value. This helps to document assumptions and catch invalid values before they can cause faults. |
| ::Assertions | <ul><li>::Every private method</li><li>::Every private method in COMPONENT-NAME</li><li>::All private methods that modify data</li></ul> | ::Assertions will be used to validate all arguments to private methods. Since these methods are only called from our other methods, arguments passed to them should always be valid, unless our code is defective. Assertions will also be used to test class invariants and some postconditions. | | ::Assertions | <ul><li>::Every private method</li><li>::Every private method in COMPONENT-NAME</li><li>::All private methods that modify data</li></ul> | ::Assertions will be used to validate all arguments to private methods. Since these methods are only called from our other methods, arguments passed to them should always be valid, unless our code is defective. Assertions will also be used to test class invariants and some postconditions. |
| ::Static analysis | <ul><li>::Strict compiler warnings</li><li>::Automated style checking</li><li>::XML validation</li><li>Detetect common errors</li></ul> | ::We will use source code analysis tools to automatically detect errors. Style checkers will help make all of our code consistent with our coding standards. XML validation ensures that each XML document conforms to its DTD. Lint-like tools help detect common programming errors. E.g.: [lint](http://www.freebsd.org/cgi/man.cgi?query=lint), [lclint/splint](http://www.splint.org/), [jlint](http://artho.com/jlint/), [checkstyle](http://sourceforge.net/projects/checkstyle/), [Jcsc](http://sourceforge.net/projects/jcsc), [PyLint](https://www.pylint.org/), [PyChecker](http://pychecker.sourceforge.net/), [Tidy](http://www.html-tidy.org/) | | ::Static analysis | <ul><li>::Strict compiler warnings</li><li>::Automated style checking</li><li>::XML validation</li><li>Detect common errors</li></ul> | ::We will use source code analysis tools to automatically detect errors. Style checkers will help make all of our code consistent with our coding standards. XML validation ensures that each XML document conforms to its DTD. Lint-like tools help detect common programming errors. E.g.: [lint](http://www.freebsd.org/cgi/man.cgi?query=lint), [lclint/splint](http://www.splint.org/), [jlint](http://artho.com/jlint/), [checkstyle](http://sourceforge.net/projects/checkstyle/), [Jcsc](http://sourceforge.net/projects/jcsc), [PyLint](https://www.pylint.org/), [PyChecker](http://pychecker.sourceforge.net/), [Tidy](http://www.html-tidy.org/) |
| ::Buddy review | <ul><li>::All changes to release branches</li><li>::All changes to COMPONENT-NAME</li><li>::All changes</li></ul> | ::Whenever changes must be made to code on a release branch (e.g., to prepare a maintenance release) the change will be reviewed by another developer before it is committed. The goal is to make sure that fixes do not introduce new defects. | | ::Buddy review | <ul><li>::All changes to release branches</li><li>::All changes to COMPONENT-NAME</li><li>::All changes</li></ul> | ::Whenever changes must be made to code on a release branch (e.g., to prepare a maintenance release) the change will be reviewed by another developer before it is committed. The goal is to make sure that fixes do not introduce new defects. |
| ::Review meetings | <ul><li>::Weekly</li><li>::Once before release</li><li>::Every source file</li></ul> | ::We will hold review meetings where developers will perform formal inspections of selected code or documents. We choose to spend a small, predetermined amount of time and try to maximize the results by selecting review documents carefully. In the review process we will use and maintain a variety of checklists. | | ::Review meetings | <ul><li>::Weekly</li><li>::Once before release</li><li>::Every source file</li></ul> | ::We will hold review meetings where developers will perform formal inspections of selected code or documents. We choose to spend a small, predetermined amount of time and try to maximize the results by selecting review documents carefully. In the review process we will use and maintain a variety of checklists. |
| ::Unit testing | <ul><li>::100% of public methods, and 75% of statements</li><li>::100% of public methods</li><li>::75% of statements</li></ul> | ::We will develop and maintain a unit test suite using the JUnit framework. We will consider the boundary conditions for each argument and test both sides of each boundary. Tests must be run and passed before each commit, and they will also be run by the testing team. Each public method will have at least one test. And, the overall test suite will exercise at least 75% of all executable statements in the system. | | ::Unit testing | <ul><li>::100% of public methods, and 75% of statements</li><li>::100% of public methods</li><li>::75% of statements</li></ul> | ::We will develop and maintain a unit test suite using the JUnit framework. We will consider the boundary conditions for each argument and test both sides of each boundary. Tests must be run and passed before each commit, and they will also be run by the testing team. Each public method will have at least one test. And, the overall test suite will exercise at least 75% of all executable statements in the system. |
@ -267,7 +270,7 @@ and tracked to completion.*
this plan as needed. this plan as needed.
::No, this plan leaves open several quality risks that have been noted ::No, this plan leaves open several quality risks that have been noted
in the [Risk Management](Project-Plan#Risk-Management) section of the in the [Risk Management](Project-Plan#Risk-Management) section of the
[Project Plan](Project-Plan). [Project Plan](Project-Plan).
#### Have human resources been allocated to carry out the QA activities? #### Have human resources been allocated to carry out the QA activities?
@ -300,5 +303,5 @@ is welcome.
::No, some developers are not aware of the quality goals and planned ::No, some developers are not aware of the quality goals and planned
QA activities for this release. This is a risk that is noted in the QA activities for this release. This is a risk that is noted in the
[Risk Management](Project-Plan#Risk-Management) section of the [Risk Management](Project-Plan#Risk-Management) section of the
[Project Plan](Project-Plan). [Project Plan](Project-Plan).

1
Release-Checklist.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
*TODO: For each release, copy this file and fill in answers to the *TODO: For each release, copy this file and fill in answers to the
questions. In cases where multiple answers are already written, delete questions. In cases where multiple answers are already written, delete
those answers that do not apply.* those answers that do not apply.*

33
Release-Notes.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
*TODO: For each release, copy this file and fill in the needed *TODO: For each release, copy this file and fill in the needed
information.* information.*
@ -6,11 +7,11 @@ number, not internal information.*
##### Product ##### Product
::[PRODUCT-NAME](http://www.COMPANY.com/products/PRODUCT-NAME/) ::[PRODUCT-NAME](http://www.COMPANY.com/products/PRODUCT-NAME/)
##### Release Number ##### Release Number
::X.Y.Z ::X.Y.Z
##### Release Date ##### Release Date
@ -18,8 +19,8 @@ number, not internal information.*
##### Customer Support ##### Customer Support
::For more information or support, please visit our ::For more information or support, please visit our
[website](http://www.COMPANY.com/products/PRODUCT-NAME/) or email us [website](http://www.COMPANY.com/products/PRODUCT-NAME/) or email us
at <support@COMPANY.com> at <support@COMPANY.com>
--- ---
@ -149,13 +150,13 @@ prior to generating the report, if you notice that they are incorrect.
You may exclude or summarize changes that might give away valuable You may exclude or summarize changes that might give away valuable
proprietary information.* proprietary information.*
- ::FIX [09823](#) Screen frozen when caps-lock is on - ::FIX [09823](#tbd) Screen frozen when caps-lock is on
- ::FIX [09912](#) Static heard while downloading - ::FIX [09912](#tbd) Static heard while downloading
- ::FIX [10923](#) Repeat-mode cannot play more than 99 times - ::FIX [10923](#tbd) Repeat-mode cannot play more than 99 times
- ::ENHANCEMENT [08237](#) Scratch DJ-mode - ::ENHANCEMENT [08237](#tbd) Scratch DJ-mode
- ::ENHANCEMENT [08238](#) Chill DJ-mode - ::ENHANCEMENT [08238](#tbd) Chill DJ-mode
- ::ENHANCEMENT [08259](#) Retro stereo-mode - ::ENHANCEMENT [08259](#tbd) Retro stereo-mode
- ::ENHANCEMENT [10202](#) Techno-mode - ::ENHANCEMENT [10202](#tbd) Techno-mode
### Known Problems and Workarounds ### Known Problems and Workarounds
@ -164,11 +165,11 @@ defects discovered in this release, or in previous releases that are
still not resolved. Include information on workarounds from the issues. still not resolved. Include information on workarounds from the issues.
Otherwise, same as above.* Otherwise, same as above.*
- ::DEFECT [07293](#) Player skips on very loud playback. - ::DEFECT [07293](#tbd) Player skips on very loud playback.
- ::WORKAROUND: Limit volume to settings 1 through 9. - ::WORKAROUND: Limit volume to settings 1 through 9.
- ::DEFECT [10509](#) Cannot switch directly from random play mode to - ::DEFECT [10509](#tbd) Cannot switch directly from random play mode to
Internet play-list. Internet play-list.
- ::WORKAROUND: Switch to local play-list first. Click [here](#) for - ::WORKAROUND: Switch to local play-list first. Click [here](#tbd) for
detailed instructions. detailed instructions.
- ::DEFECT [10589](#) Static heard while booting - ::DEFECT [10589](#tbd) Static heard while booting
- ::DEFECT [10944](#) Repeat-mode cannot play more than 999 times - ::DEFECT [10944](#tbd) Repeat-mode cannot play more than 999 times

3
Resource-Needs.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
@ -6,7 +7,7 @@
::X.Y.Z ::X.Y.Z
##### Project Time-frame: ##### Project Time-frame
::START-DATE - END-DATE ::START-DATE - END-DATE

4
Review-Meeting-Checklists.md
View File

@ -4,9 +4,9 @@
## Checklists for Types of Artifacts ## Checklists for Types of Artifacts
- ::[Checklists for peer reviews](http://processimpact.com/pr_goodies.shtml) - ::[Checklists for peer reviews](http://processimpact.com/pr_goodies.shtml)
by Karl E. Wiegers by Karl E. Wiegers
- ::[Checklists for UML design](http://www.modelingstyle.info/) - ::[Checklists for UML design](http://www.modelingstyle.info/)
by Scott W. Ambler by Scott W. Ambler
## Style Guides ## Style Guides

6
Review-Meeting-Notes.md
View File

@ -1,3 +1,5 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
@ -30,8 +32,8 @@
### Documents and Code Reviewed at this Meeting ### Documents and Code Reviewed at this Meeting
- ::[Feature list section of requirements](#) - ::[Feature list section of requirements](#tbd)
- ::[Multi-user section of requirements](#) - ::[Multi-user section of requirements](#tbd)
- ::[Hello.java](/source/browse/PROJECT-NAME/src/Hello.java) - ::[Hello.java](/source/browse/PROJECT-NAME/src/Hello.java)
- ::[HelloStream.java](/source/browse/PROJECT-NAME/src/HelloStream.java) - ::[HelloStream.java](/source/browse/PROJECT-NAME/src/HelloStream.java)
- ::[HelloPanel.java](/source/browse/PROJECT-NAME/src/HelloPanel.java) - ::[HelloPanel.java](/source/browse/PROJECT-NAME/src/HelloPanel.java)

9
Risks.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
@ -11,7 +12,7 @@
- [Project plan](Project-Plan) - [Project plan](Project-Plan)
- [Software development methodology](SDM) - [Software development methodology](SDM)
##### 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)
@ -55,7 +56,7 @@ take away our lessons learned and any valuable project bi-products.
pretend everything is fine and hope that none of the pretend everything is fine and hope that none of the
stakeholders notice. stakeholders notice.
#### Risks that consume development resources. #### Risks that consume development resources
::The project has a fixed deadline. The requirements are prioritized. ::The project has a fixed deadline. The requirements are prioritized.
If we lose time, we will reduce project scope. If we lose time, we will reduce project scope.
@ -76,7 +77,7 @@ delivery date.
| Name | Description | Likelihood | Impact | Plan | Status | Owner | | Name | Description | Likelihood | Impact | Plan | Status | Owner |
|-----------------|---------------------------------------------------------------------------------------------------------------------------------|------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|-------------------| |-----------------|---------------------------------------------------------------------------------------------------------------------------------|------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|-------------------|
| ::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 |
@ -173,4 +174,4 @@ the project could deliver.
RISKNAME RISKNAME
RISKNAME and strength of character of RISKNAME and strength of character of
RISKNAME RISKNAME
RISKNAME RISKNAME

3
SDM.md
View File

@ -1,5 +1,6 @@
<!-- markdownlint-disable-next-line MD041 -->
*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.

7
SRS.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::PROJECT-NAME ::PROJECT-NAME
@ -6,7 +7,7 @@
::X.Y.Z ::X.Y.Z
##### Attached worksheets: ##### Attached worksheets
- SRS > [Use case suite](Use-Case-Suite) - SRS > [Use case suite](Use-Case-Suite)
- SRS > [Feature set](Feature-Set) - SRS > [Feature set](Feature-Set)
@ -249,8 +250,8 @@ Details:
- ::The system will store all data in a standard SQL database, where - ::The system will store all data in a standard SQL database, where
it can be accessed by other programs. it can be accessed by other programs.
- ::The system will store all data in an XML file, using a - ::The system will store all data in an XML file, using a
[standard DTD](LINK-TO-STANDARD). [standard DTD](LINK-TO-STANDARD).
- ::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

23
Status-Report.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
*TODO: Copy this file for each status report. Fill in the information *TODO: Copy this file for each status report. Fill in the information
below. Email a notification to stakeholders when this report is made below. Email a notification to stakeholders when this report is made
available.* available.*
@ -25,29 +26,29 @@ examples are given, you should select/edit only one.*
- ::Change Since Last Report: Slipped 2 days - ::Change Since Last Report: Slipped 2 days
- ::Change Since Last Report: Saved 4 days - ::Change Since Last Report: Saved 4 days
##### Open Issues (needing development): ##### Open Issues (needing development)
- ::[17 defects](ISSUE-TRACKER-QUERY) - ::[17 defects](ISSUE-TRACKER-QUERY)
- ::[8 enhancements](#) - ::[8 enhancements](#tbd)
##### Resolved Issues (pending verification): ##### Resolved Issues (pending verification)
- ::[0 defects](#) - ::[0 defects](#tbd)
- ::[2 enhancements](#) - ::[2 enhancements](#tbd)
##### Closed Issues: ##### Closed Issues
- ::[34 defects](#) - ::[34 defects](#tbd)
- ::[3 enhancements](#) - ::[3 enhancements](#tbd)
##### Resources used this period: ##### Resources used this period
- ::PERSON-NAME: 18 hours. - ::PERSON-NAME: 18 hours.
- ::PERSON-NAME: 15 hours. - ::PERSON-NAME: 15 hours.
- ::PERSON-NAME: 10 hours. - ::PERSON-NAME: 10 hours.
- ::PERSON-NAME: 12 hours. - ::PERSON-NAME: 12 hours.
##### Status Summary: ##### Status Summary
- ::Project completed. This is the final status report. - ::Project completed. This is the final status report.
- ::Low risk. Project on track. - ::Low risk. Project on track.
@ -110,7 +111,7 @@ possible.*
- ::Fix [issue 130](ISSUE-TRACKER-URL) - ::Fix [issue 130](ISSUE-TRACKER-URL)
- ::Fix [issue 133](ISSUE-TRACKER-URL) - ::Fix [issue 133](ISSUE-TRACKER-URL)
- ::Verify [issue 102](ISSUE-TRACKER-URL), [issue 103](ISSUE-TRACKER-URL), - ::Verify [issue 102](ISSUE-TRACKER-URL), [issue 103](ISSUE-TRACKER-URL),
[issue 107](ISSUE-TRACKER-URL), and [issue 109](ISSUE-TRACKER-URL) [issue 107](ISSUE-TRACKER-URL), and [issue 109](ISSUE-TRACKER-URL)
- ::Conduct regular team meeting: Tuesday, 1 hour - ::Conduct regular team meeting: Tuesday, 1 hour
- ::Conduct review meeting: Wednesday, 2 hours - ::Conduct review meeting: Wednesday, 2 hours

23
Summary.md
View File

@ -1,6 +1,7 @@
<!-- markdownlint-disable-next-line MD041 -->
### Mission and Scope ### Mission and Scope
*TODO: Answer these questions in your own words. This is condensed *TODO: Answer these questions in your own words. This is condensed
from the project [Home](Home).* from the project [Home](Home).*
#### What problem does this project address? #### What problem does this project address?
@ -35,7 +36,7 @@ functionality and a wider set of testers.
### Resources and schedule ### Resources and schedule
*TODO: Briefly describe the project resources and schedule. This is *TODO: Briefly describe the project resources and schedule. This is
condensed from the [project plan](Project-Plan), [resource needs](Resource-Needs), condensed from the [project plan](Project-Plan), [resource needs](Resource-Needs),
and [legal issues](legal.html) documents.* and [legal issues](legal.html) documents.*
#### What are the deadlines for this project? #### What are the deadlines for this project?
@ -66,10 +67,10 @@ and [legal issues](legal.html) documents.*
### Requirements ### Requirements
*TODO: Briefly describe the most important system requirements. This is *TODO: Briefly describe the most important system requirements. This is
condensed from the [user needs](User-Needs), condensed from the [user needs](User-Needs),
[interview notes](interview-notes.html), [SRS](SRS), [interview notes](interview-notes.html), [SRS](SRS),
[use case suite](Use-Case-Suite), [use case suite](Use-Case-Suite),
and [feature set](Feature-Set) documents.* and [feature set](Feature-Set) documents.*
#### Who are the project stakeholders? #### Who are the project stakeholders?
@ -102,7 +103,7 @@ worksheets.*
1. ::Correctness 1. ::Correctness
- ::This design correctly matches the - ::This design correctly matches the
given requirements. given requirements.
2. ::Feasibility 2. ::Feasibility
- ::This design can be implemented and tested with the - ::This design can be implemented and tested with the
planned amount of time and effort. planned amount of time and effort.
3. ::Understandability 3. ::Understandability
@ -207,18 +208,18 @@ Where is the user documentation?
the team would not already know them. This is condensed from the the team would not already know them. This is condensed from the
[glossary](Glossary) documents.* [glossary](Glossary) documents.*
##### ::TECHNICAL TERM 1 #### ::TECHNICAL TERM 1
::DEFINITION ::DEFINITION
##### ::TECHNICAL TERM 2 #### ::TECHNICAL TERM 2
::DEFINITION ::DEFINITION
##### ::TECHNICAL TERM 3 #### ::TECHNICAL TERM 3
::DEFINITION ::DEFINITION
##### ::TECHNICAL TERM 4 #### ::TECHNICAL TERM 4
::DEFINITION ::DEFINITION

19
Target-and-Benefits.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
@ -33,7 +34,7 @@ examples. Delete them and answer in your own words.*
::Open source development tools for SQL database design. ::Open source development tools for SQL database design.
#### What is the target market for this product? Include specific defining characteristics. #### What is the target market for this product? Include specific defining characteristics?
::Experienced console game players age 13-35 who enjoy first-person ::Experienced console game players age 13-35 who enjoy first-person
shooter games with detailed character animation models and shooter games with detailed character animation models and
@ -43,22 +44,22 @@ cinematic segments.
games, and other content to high-end phones and who are concerned games, and other content to high-end phones and who are concerned
about the potential for viruses. about the potential for viruses.
#### What is the size of the total available market? Cite references for facts. #### What is the size of the total available market? Cite references for facts?
::10,000 users \[[magazine article](#)\]. ::10,000 users \[[magazine article](#tbd)\].
::$10M, growing annually at 4% \[[industry analyst](#)\]. ::$10M, growing annually at 4% \[[industry analyst](#tbd)\].
#### What are some other customer options or leading products that address the same needs? #### What are some other customer options or leading products that address the same needs?
- ::[Competitor 1](#) - ::[Competitor 1](#tbd)
- ::[Competitor 2](#) - ::[Competitor 2](#tbd)
- ::[Do-it-yourself solutions](#) - ::[Do-it-yourself solutions](#tbd)
#### Are there any known customers for this product? #### Are there any known customers for this product?
- ::[MegaCorp, corporate I.T. department](#) - ::[MegaCorp, corporate I.T. department](#tbd)
- ::[Worldwide Global Corporation](#) - ::[Worldwide Global Corporation](#tbd)
- ::Our own in-house application software developers and server - ::Our own in-house application software developers and server
operations team operations team
- ::Our own marketing, sales, and customer support departments - ::Our own marketing, sales, and customer support departments

2
Test-Case-Format.md
View File

@ -1,4 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Related Documents ##### Related Documents
- [QA Plan](QA-Plan) > [Test Suite](Test-Suite) > Test Case Format - [QA Plan](QA-Plan) > [Test Suite](Test-Suite) > Test Case Format

5
Test-Cases.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
@ -187,8 +188,8 @@ values are written in set notation, one per line. E.g.:
**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
up or put more information into the feature descriptions. up or put more information into the feature descriptions.
**Prerequisite:** **Prerequisite:**

3
Test-Run-Suite.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
@ -26,7 +27,7 @@ assess risk, and focus ongoing testing efforts.
- *Review the [target audience](Target-and-Benefits), - *Review the [target audience](Target-and-Benefits),
[environmental requirements](SRS#environmental), and [possible [environmental requirements](SRS#environmental), and [possible
deployments](Design-Architecturel#deployment) to understand the deployments](Design-Architecture#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.*

3
Test-Runs.md
View File

@ -1,5 +1,4 @@
##### Project <!-- markdownlint-disable-next-line MD041 -->##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
##### Internal Release Number ##### Internal Release Number

2
Test-Suite.md
View File

@ -1,3 +1,5 @@
<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)

2
Use-Case-Format.md
View File

@ -1,4 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Related Documents ##### Related Documents
- [SRS](SRS) > [Use Case Suite](Use-Case-Suite) > Use Case Format - [SRS](SRS) > [Use Case Suite](Use-Case-Suite) > Use Case Format

8
Use-Case-Suite.md
View File

@ -1,3 +1,5 @@
<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
@ -30,9 +32,9 @@ 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 needs](User-Needs) *TIP: Refer back to the user stories in your [user needs](User-Needs)
document. Use them for ideas and make sure that you cover all of them. document. Use them for ideas and make sure that you cover all of them.
Remember that use cases are more precise than user stories, and there Remember that use cases are more precise than 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

9
Use-Cases.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::PROJECT-NAME ::PROJECT-NAME
@ -47,7 +48,7 @@ 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 *TIP: See detailed tips in the
[guidelines for writing use cases](Use-Case-Format#further-information).* [guidelines for writing use cases](Use-Case-Format#further-information).*
--- ---
@ -85,8 +86,8 @@ cases first and come back to less important ones later.*
**Notes and Questions:** **Notes and Questions:**
- ::How will administrators know the right timezone abbreviation? - ::How will administrators know the right timezone abbreviation?
- They would know it if they live in that timezone. Maybe we could - They would know it if they live in that timezone. Maybe we could
provide a drop-down list of all choices, but each would need some explanation. provide a drop-down list of all choices, but each would need some explanation.
--- ---
@ -152,7 +153,7 @@ cases first and come back to less important ones later.*
### UC-03: Edit user profile ### UC-03: Edit user profile
** Summary:** **Summary:**
::Users can edit their own account preferences. ::Users can edit their own account preferences.

3
User-Guide.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
*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.*
@ -16,7 +17,7 @@ information.*
##### Customer Support ##### Customer Support
::For more information or support, please visit our ::For more information or support, please visit our
[website](http://www.COMPANY.com/products/PRODUCT-NAME/) or email [website](http://www.COMPANY.com/products/PRODUCT-NAME/) or email
us at <support@COMPANY.com> us at <support@COMPANY.com>

5
User-Needs.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](Home)
@ -44,7 +45,7 @@ will be hyper-linked from here.
### Environment ### Environment
*TODO: Briefly describe various aspects of the environment where the *TODO: Briefly describe various aspects of the environment where the
software will be used. Describe the environment as it *is* or *will be*, software will be used. Describe the environment as it \*is\* or \*will be\*,
not what you would wish it to become. The text below gives a few not what you would wish it to become. The text below gives a few
examples.* examples.*
@ -182,7 +183,7 @@ it here.*
*TODO: Write brief user stories to explain how various actors would *TODO: Write brief user stories to explain how various actors would
interact with the system (directly and indirectly) to accomplish a interact with the system (directly and indirectly) to accomplish a
real-world goal. User stories are *not* use cases: user stories are real-world goal. User stories are \*not\* use cases: user stories are
brief (3-5 sentences) paragraphs that describe one specific scenario in brief (3-5 sentences) paragraphs that describe one specific scenario in
concrete terms. In this description of user needs, do not make concrete terms. In this description of user needs, do not make
assumptions about details of the system, instead focus on the users. assumptions about details of the system, instead focus on the users.

3
Workflows.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD041 -->
### By Activity ### By Activity
1. Project Planning 1. Project Planning
@ -123,5 +124,5 @@
- [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 clone from [ReadySet GFM](https://github.com/bike-bill/readyset-gfm/wiki) "readyset" or clone from [ReadySet GFM](https://github.com/bike-bill/readyset-gfm/wiki)
on Github. on Github.