GFM changes
This commit is contained in:
parent
d26aead694
commit
45c9b866b7
@ -5,8 +5,8 @@
|
||||
::X.Y.Z
|
||||
|
||||
##### Related Documents:
|
||||
- [Project proposal](Proposal) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [SRS](SRS) > [Use case suite](Use-Case-Suite)
|
||||
- [Project proposal](Proposal) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [SRS](SRS) > [Use case suite](Use-Case-Suite)
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
- ::LINKS TO OTHER DOCUMENTS
|
||||
---
|
||||
|
@ -5,7 +5,7 @@
|
||||
::X.Y.Z
|
||||
|
||||
##### Related Documents:
|
||||
- [Design](Design) > Design Architecture
|
||||
- [Design](Design) > Design Architecture
|
||||
- [Software Requirements Specification](SRS)
|
||||
- [Glossary](Glossary)
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
|
@ -5,7 +5,7 @@
|
||||
::X.Y.Z
|
||||
|
||||
##### Related Documents:
|
||||
- [Design](Design)> [Architecture](Design-Architecture) > Design Components
|
||||
- [Design](Design)> [Architecture](Design-Architecture) > Design Components
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
- ::LINKS TO OTHER DOCUMENTS
|
||||
|
||||
|
@ -101,10 +101,10 @@ features. Some example text is provided. Add or delete text as needed.*
|
||||
- ::Each action (information display or change) requires that the
|
||||
user has a role with proper permissions
|
||||
- ::Compromised or abused accounts can be quickly disabled
|
||||
by administrators.
|
||||
- ::Administrators can review user permissions
|
||||
- ::Administrators can audit all accesses and changes
|
||||
- ::All communications with the user are encrypted (e.g., SSL)
|
||||
by administrators. >
|
||||
- ::Administrators can review user > permissions
|
||||
- ::Administrators can audit all a > ccesses and changes
|
||||
- ::All communications with the us > er are encrypted (e.g., SSL)
|
||||
- ::Some communications with the user (e.g., the username
|
||||
and password) are encrypted (e.g., SSL)
|
||||
- ::Sessions are tied to a particular client IP-address so that
|
||||
|
@ -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 -->
|
||||
|
||||
# [Design](Design) > Source Code Organization and Build System
|
||||
---
|
||||
|
||||
##### Project:
|
||||
::PROJECTNAME
|
||||
|
||||
@ -29,6 +5,7 @@
|
||||
::X.Y.Z
|
||||
|
||||
##### Related Documents:
|
||||
- [Design](Design) > Source Code Organization and Build System
|
||||
- ::[Example build.xml for Tomcat](http://jakarta.apache.org/tomcat/tomcat-4.1-doc/appdev/build.xml.txt)
|
||||
- ::[Apache Ant manual](http://ant.apache.org/manual/index)
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
@ -144,23 +121,3 @@ aimed at specific platforms.
|
||||
::Yes, everyone understands. Feedback is welcome.
|
||||
|
||||
::No, this is a risk that is noted in the [Risk Management](Project-Plan#risks) section.
|
||||
|
||||
<!-- 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>
|
||||
|
49
Design-UI.md
49
Design-UI.md
@ -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 -->
|
||||
|
||||
# [Design](Design) > User Interface
|
||||
---
|
||||
|
||||
##### Project:
|
||||
::PROJECTNAME
|
||||
|
||||
@ -29,6 +5,7 @@
|
||||
::X.Y.Z
|
||||
|
||||
##### Related Documents:
|
||||
- [Design](Design) > User Interface
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
- ::LINKS TO OTHER DOCUMENTS
|
||||
---
|
||||
@ -36,7 +13,7 @@
|
||||
### Overview
|
||||
|
||||
*TODO: Answer the questions below to help you design the user interface
|
||||
features of your system. Some ecomponents.htmlxample text is provided. Add or delete
|
||||
features of your system. Some example text is provided. Add or delete
|
||||
text as needed.*
|
||||
|
||||
#### What are the most important facts that a developer should know about the user interface of this system?
|
||||
@ -67,7 +44,7 @@ text as needed.*
|
||||
|
||||
#### What UI design standards, guidelines, and styles are you following?
|
||||
|
||||
- ::[Microsoft UI guidelines](hcomponents.htmlttp://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwue/html/welcome.asp)
|
||||
- ::[Microsoft UI guidelines](http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwue/html/welcome.asp)
|
||||
- ::[Java UI guidelines](http://java.sun.com/products/jlf/ed1/guidelines.html)
|
||||
- ::[Mac UI guidelines](http://developer.apple.com/techpubs/macosx/Essentials/AquaHIGuidelines/AHIGHIGs/index.html)
|
||||
- ::[W3C Accessibility guidelines](http://www.w3.org/TR/WCAG10/)
|
||||
@ -237,23 +214,3 @@ may add or remove questions to fit your project.*
|
||||
#####Are labels used consistently throughout the system? E.g., not "forward/back" in some contexts and "next/prev" in others.
|
||||
|
||||
::1-3 SENTENCES
|
||||
|
||||
<!-- 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>
|
||||
|
64
Design.md
64
Design.md
@ -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 -->
|
||||
|
||||
# Design
|
||||
---
|
||||
|
||||
##### Project:
|
||||
::[PROJECTNAME](Home)
|
||||
|
||||
@ -29,16 +5,16 @@
|
||||
::X.Y.Z
|
||||
|
||||
##### Attached Worksheets:
|
||||
- Design > [Architecture Worksheet](Design-Architecture)
|
||||
- Design > [Source Organization and Build Worksheet](design-src-org.html)
|
||||
<!-- - Design > [Scalability Worksheet](design-scalability.html) -->
|
||||
- Design > [User Interface Worksheet](design-ui.html)
|
||||
- Design > [Persistent Storage Worksheet](design-persistence.html)
|
||||
- Design > [Security Worksheet](Design-Security)
|
||||
- Design > [Architecture Worksheet](Design-Architecture)
|
||||
- Design > [Source Organization and Build Worksheet] > (Design-Src-Org)
|
||||
<!-- - Design > [Scalability Worksheet](Design-Scalability) -->
|
||||
- Design > [User Interface Worksheet](Design-UI)
|
||||
- Design > [Persistent Storage Worksheet](Design-Persistence)
|
||||
- Design > [Security Worksheet](Design-Security)
|
||||
|
||||
##### Related Documents:
|
||||
- [SRS](srs) > [Use case suite](use-case-suite.html)
|
||||
- [SRS](srs) > [Feature set](feature-set.html)
|
||||
- [SRS](SRS) > [Use case suite](Use-Case-Suite)
|
||||
- [SRS](SRS) > [Feature set](Feature-Set)
|
||||
- [Glossary](Glossary)
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
- ::LINKS TO OTHER DOCUMENTS
|
||||
@ -96,7 +72,7 @@ system's structure in detail.*
|
||||
|
||||
::ANY ADDITIONAL NOTES OR COMMENTS
|
||||
|
||||
### [UML Behavioral Design](#uml-behavioral-design)
|
||||
### UML Behavioral Design
|
||||
|
||||
*TODO: Link to a design model and/or design diagrams that describe your
|
||||
system's behavior in detail.*
|
||||
@ -121,7 +97,7 @@ system's behavior in detail.*
|
||||
|
||||
::ANY ADDITIONAL NOTES OR COMMENTS
|
||||
|
||||
### [UML Design Checklist](#uml-design-checklist)
|
||||
### UML Design Checklist
|
||||
|
||||
*TODO: Answer the following questions to help evaluate your design. Add
|
||||
or remove questions to fit your project. If you cannot answer a question
|
||||
@ -156,23 +132,3 @@ revised.*
|
||||
- ::Yes, everyone understands. Feedback is welcome.
|
||||
- ::No, this is a risk that is noted in the
|
||||
[Risk Management](Project-Plan#risks) section.
|
||||
|
||||
<!-- 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>
|
||||
|
@ -1,31 +1,7 @@
|
||||
<!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 -->
|
||||
|
||||
# Document cross reference
|
||||
---
|
||||
|
||||
*TODO: This template is not done yet. Feel free to contribute your ideas.*
|
||||
|
||||
This document defines the artifacts the team creates during your software
|
||||
developement process. Documenting artifact types helps define the inputs and
|
||||
development process. Documenting artifact types helps define the inputs and
|
||||
outputs of each development task. The producer/consumer matrix helps document
|
||||
the software development workflow.
|
||||
|
||||
@ -33,31 +9,11 @@ the software development workflow.
|
||||
|
||||
| Read By \ Written By | Everyone | Project Manager | Product Manager | Dev Team | QA Team | Tech Writer | Tech Support | Operations | Sales |
|
||||
|------------------------|-----------------|-----------------|-----------------|----------|---------|-------------|--------------|------------|-------|
|
||||
| ::Everyone | [SDM](sdm.html) | | | | | | | | |
|
||||
| ::Project Mananger | | | | | | | | | |
|
||||
| ::Everyone | [SDM](SDM) | | | | | | | | |
|
||||
| ::Project Manager | | | | | | | | | |
|
||||
| ::Dev Team | | | | | | | | | |
|
||||
| ::QA Team | | | | | | | | | |
|
||||
| ::Tech Writer | | | | | | | | | |
|
||||
| ::Tech Support | | | | | | | | | |
|
||||
| ::Operations | | | | | | | | | |
|
||||
| ::Sales | | | | | | | | | |
|
||||
|
||||
<!-- 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>
|
||||
|
69
FAQ.md
69
FAQ.md
@ -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 FAQ
|
||||
---
|
||||
|
||||
*TODO: Answer these common questions. Some sample answers are provided
|
||||
for you. Add new questions and new sections to fit the needs of your
|
||||
users.*
|
||||
@ -33,22 +9,25 @@ contributors, members of a developers' network, or administrators.*
|
||||
### General Information
|
||||
|
||||
#### What is ::PRODUCTNAME?
|
||||
|
||||
::It is a XXXXX. Read our [PRODUCTNAME overview](http://www.COMPANY.com/products/PRODUCTNAME/).
|
||||
|
||||
#### Who should use ::PRODUCTNAME?
|
||||
|
||||
::Anyone who wants XXXXXXX. Read more about our [target audience and
|
||||
benefits](Target-and-Benefits).
|
||||
|
||||
### Download and Install
|
||||
|
||||
#### How can I obtain ::PRODUCTNAME?
|
||||
|
||||
::You may [download PRODUCTNAME](LINK-TO-DOWNLOAD).
|
||||
|
||||
::You may [place an order for PRODUCTNAME](LINK-TO-ORDER).
|
||||
|
||||
#### What do I need to use ::PRODUCTNAME?
|
||||
::System requirements are described in the [release
|
||||
notes](release-notes.html).
|
||||
|
||||
::System requirements are described in the [release notes](Release-Notes).
|
||||
|
||||
::System requirements are a Intel-compatible PC with a processor speed
|
||||
of at least XXX MHz, XXX MB of RAM. XXX MB of free disk space, and
|
||||
@ -56,21 +35,26 @@ one of the following operating systems: Windows 98/2000/XP, Mac
|
||||
OSX, Linux.
|
||||
|
||||
#### How do I install ::PRODUCTNAME?
|
||||
|
||||
::[Installation instructions](install.html) are available on-line.
|
||||
|
||||
#### How do I upgrade from an older version of PRODUCTNAME?
|
||||
|
||||
::[Installation instructions](install.html) are available on-line.
|
||||
|
||||
### Getting Started
|
||||
|
||||
#### What is ::TECHNICAL-TERM?
|
||||
|
||||
::It means XXXXX. For additional technical terms, see the
|
||||
[glossary](Glossary).
|
||||
|
||||
#### What is ::GUI-ELEMENT?
|
||||
|
||||
::It is a XXXXX. It is used for YYYYY.
|
||||
|
||||
#### How do I do ::COMMON-TASK?
|
||||
|
||||
::You should understand that XXX. Once you are ready, you can:
|
||||
|
||||
1. ::Step one
|
||||
@ -79,32 +63,38 @@ OSX, Linux.
|
||||
|
||||
### SECTION NAME
|
||||
|
||||
|
||||
#### ::QUESTION?
|
||||
|
||||
::ANSWER.
|
||||
|
||||
#### ::QUESTION?
|
||||
|
||||
::ANSWER.
|
||||
|
||||
#### ::QUESTION?
|
||||
|
||||
::ANSWER.
|
||||
|
||||
#### ::QUESTION?
|
||||
|
||||
::ANSWER.
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
#### ::I see an error message "ERROR-MESSAGE". What's wrong?
|
||||
|
||||
::ANSWER.
|
||||
|
||||
#### ::I can't do COMMON-TASK. What's wrong?
|
||||
|
||||
::ANSWER.
|
||||
|
||||
### Other Questions
|
||||
|
||||
|
||||
#### ::My question is not on this page. How do I find the answer?
|
||||
:: First read the [user guide](user-guide) and other
|
||||
|
||||
::First read the [user guide](user-guide) and other
|
||||
on-line help. Your question may have already been asked and
|
||||
answered, to find it: search the project [mail archives](#) and
|
||||
[issue tracking system](#). If you still don't find it, you can ask
|
||||
@ -112,25 +102,6 @@ the question on the [users' mailing list](#) or the [developers'
|
||||
mailing list](#) or you can [enter an issue](#).
|
||||
|
||||
#### ::Where should I send comments on this FAQ?
|
||||
:: You can write to [EMAIL-ADDRESS](mailto:#) or any of the developers
|
||||
|
||||
::You can write to [EMAIL-ADDRESS](mailto:#) or any of the developers
|
||||
on the [developers' mailing list](mailto:#).
|
||||
|
||||
<!-- 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>
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [SRS](SRS) > [Feature Set](feature-set.html) > Feature Specification Format
|
||||
# [SRS](SRS) > [Feature Set](Feature-Set) > Feature Specification Format
|
||||
---
|
||||
|
||||
**Process impact:** This reference page documents the format of feature
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [SRS](SRS) > Feature Set
|
||||
# [SRS](SRS) > Feature Set
|
||||
---
|
||||
|
||||
##### Project:
|
||||
@ -30,7 +30,7 @@
|
||||
|
||||
##### Related Documents:
|
||||
- [Project proposal](proposal.html) > [User needs](user-needs.html)
|
||||
- [SRS](SRS) > [Use case suite](use-case-suite.html)
|
||||
- [SRS](SRS) > [Use case suite](Use-Case-Suite)
|
||||
- [Feature format](feature-format.html)
|
||||
- ::LINK TO USE CASE DIAGRAM
|
||||
- ::LINKS TO RELEVANT STANDARDSuser-needs
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [SRS](SRS) > [Feature Set](feature-set.html) > Features
|
||||
# [SRS](SRS) > [Feature Set](Feature-Set) > Features
|
||||
---
|
||||
|
||||
##### Project:
|
||||
@ -30,7 +30,7 @@
|
||||
|
||||
##### Related Documents:
|
||||
- [Project proposal](proposal.html) > [User needs](user-needs.html)
|
||||
- [SRS](srs) > [Use case suite](use-case-suite.html)
|
||||
- [SRS](SRS) > [Use case suite](Use-Case-Suite)
|
||||
- [Feature format](feature-format.html)
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
- ::LINKS TO OTHER DOCUMENTS
|
||||
@ -38,7 +38,7 @@
|
||||
|
||||
**Process impact:** This is a set of detailed feature descriptions.
|
||||
|
||||
*TODO: For each feature listed in the [feature set](feature-set.html),
|
||||
*TODO: For each feature listed in the [feature set](Feature-Set),
|
||||
give a detailed description of the feature here. Describe each feature
|
||||
in enough detail that it could be implemented by any member of the
|
||||
development team (not only someone who already informally knows what to
|
||||
|
@ -338,50 +338,50 @@ debugging to eventually find and remove [defects](#defect).
|
||||
|
||||
### QA Goals Terms
|
||||
|
||||
#### Functionality > Correctness
|
||||
#### Functionality > Correctness
|
||||
Correctness is the most basic quality goal. It means that, when
|
||||
valid inputs are given and the system is in a valid state and under
|
||||
reasonable load, the system's behavior and results will be correct.
|
||||
|
||||
#### Functionality > Robustness
|
||||
#### Functionality > Robustness
|
||||
Robustness is the system's ability to gracefully handle
|
||||
invalid inputs. It should never be possible for any user input to
|
||||
crash the system or corrupt data, even if that user input is
|
||||
abnormal, unexpected, or malicious.
|
||||
|
||||
#### Functionality > Accuracy
|
||||
#### Functionality > Accuracy
|
||||
Accuracy refers to the mathematical precision of calculations done
|
||||
by the system. Any system that does numeric calculations must
|
||||
consider accuracy, e.g., financial or scientific applications.
|
||||
|
||||
#### Functionality > Compatibility
|
||||
#### Functionality > Compatibility
|
||||
Systems that claim to follow standards or claim compatibility with
|
||||
existing systems must adhere to the relevant file formats,
|
||||
protocols, and APIs. The relevant standards are linked at the top of
|
||||
this document.
|
||||
|
||||
#### Functionality > Factual correctness
|
||||
#### Functionality > Factual correctness
|
||||
Is the data in the system a true representation of the real world?
|
||||
Any system that contains initial data or gathers data about the real
|
||||
world should be sure that the data is factually correct. E.g., a tax
|
||||
preparation program should embody correct and up-to-date facts about
|
||||
tax law.
|
||||
|
||||
#### Usability > Understandability and Readability
|
||||
#### Usability > Understandability and Readability
|
||||
Users need to understand the system to use it. The basic metaphor
|
||||
should be understandable and appropriate to user tasks. Some defects
|
||||
in understandability include unclear metaphors, poor or hard-to-see
|
||||
labels, lack of feedback to confirm the effects of user actions, and
|
||||
missing or inadequate on-line help.
|
||||
|
||||
#### Usability > Learnability and Memorability
|
||||
#### Usability > Learnability and Memorability
|
||||
Every user interface contains some details that users will need to
|
||||
learn and remember. E.g., Alt-F to open the "File" menu. UI cues and
|
||||
rules can make these details easier to learn and remember. E.g., the
|
||||
"F" is underlined and, as a rule, the first letter is usually the
|
||||
accelerator key.
|
||||
|
||||
#### Usability > Task support
|
||||
#### Usability > Task support
|
||||
This is the quality of match between user tasks and the system's UI.
|
||||
Task support defects are cases where the system forces the user to
|
||||
take unnatural steps to accomplish a task or where the user is given
|
||||
@ -389,20 +389,20 @@ no support for a difficult step in a task. E.g., must the user
|
||||
invent an 8-character filename for their "Christmas card list"?
|
||||
E.g., must users total their own tax deductions?
|
||||
|
||||
#### Usability > Efficiency
|
||||
#### Usability > Efficiency
|
||||
Users should be able to accomplish common tasks with
|
||||
reasonable effort. Common tasks should be possible with only one or
|
||||
two steps. The difficulty of each step should also be considered.
|
||||
E.g., does the user have to remember a long code number or click on
|
||||
a very small button?
|
||||
|
||||
#### Usability > Safety
|
||||
#### Usability > Safety
|
||||
Humans are error-prone, but the negative effects of common errors
|
||||
should be limited. E.g., users should realize that a given command
|
||||
will delete data, and be asked to confirm their intent or have the
|
||||
option to undo.
|
||||
|
||||
#### Usability > Consistency and Familiarity
|
||||
#### Usability > Consistency and Familiarity
|
||||
Users should be able to apply their past experience from other
|
||||
similar systems. This means that user interface standards should be
|
||||
followed, and common conventions should be used whenever possible.
|
||||
@ -413,7 +413,7 @@ that does demand it is a consistency defect, unless there is a real
|
||||
chance that the user is dealing with another currency on that step
|
||||
in his/her task.
|
||||
|
||||
#### Usability > Subjective satisfaction
|
||||
#### Usability > Subjective satisfaction
|
||||
Users should feel generally satisfied with the UI. This is a
|
||||
subjective quality that sums up the other user interface qualities
|
||||
as well as aesthetics.
|
||||
@ -425,22 +425,22 @@ side-step security rule or exploit security holes. E.g., all user
|
||||
input should be validated and any malicious input should
|
||||
be rejected.
|
||||
|
||||
#### Reliability > Consistency under load
|
||||
#### Reliability > Consistency under load
|
||||
Every system has some capacity limits. What happens when those
|
||||
limits are exceeded? The system should never lose or corrupt data.
|
||||
|
||||
#### Reliability > Consistency under concurrency
|
||||
#### Reliability > Consistency under concurrency
|
||||
Systems that allow concurrent access by multiple users, or that use
|
||||
concurrency internally, should be free of race conditions
|
||||
and deadlock.
|
||||
|
||||
#### Reliability > Availability under load
|
||||
#### Reliability > Availability under load
|
||||
Every system has some capacity limits. What happens when those
|
||||
limits are exceeded? The system should continue to service those
|
||||
requests that it is capable of handling. It should not crash or stop
|
||||
processing all requests.
|
||||
|
||||
#### Reliability > Longevity
|
||||
#### Reliability > Longevity
|
||||
The system should continue to operate as long as it is needed. It
|
||||
should not gradually use up a limited resource. Example longevity
|
||||
defects include memory leaks or filling the disk with log files.
|
||||
@ -457,12 +457,12 @@ are increased. E.g., a file server might be scalable to a high
|
||||
number of users, or to very large files or very high capacity disks.
|
||||
Several specific scalability goals are listed below.
|
||||
|
||||
#### Scalability > Performance under load
|
||||
#### Scalability > Performance under load
|
||||
This is a specific type of scalability goal dealing with the
|
||||
performance of the system at times when it is servicing many
|
||||
requests from many users.
|
||||
|
||||
#### Scalability > Large data volume
|
||||
#### Scalability > Large data volume
|
||||
This is a specific type of scalability goal dealing with the ability
|
||||
for the system to handle large data sets. Operations should continue
|
||||
to be correct and efficient as data set size increases. Furthermore,
|
||||
@ -476,14 +476,14 @@ administrator recover from a crash? Is there sufficient log output
|
||||
to diagnose problems in the field? Can the system's data be backed
|
||||
up without downtime? Can the system be upgraded practically?
|
||||
|
||||
#### Maintainability > Understandability
|
||||
#### Maintainability > Understandability
|
||||
Will it be easy for (future) developers to understand how the system
|
||||
works?
|
||||
|
||||
#### Maintainability > Evolvability
|
||||
#### Maintainability > Evolvability
|
||||
Can the system easily be modified and extended over time?
|
||||
|
||||
#### Maintainability > Testability
|
||||
#### Maintainability > Testability
|
||||
Can the system easily be tested? Do the requirements precisely
|
||||
specify possible inputs and the desired results? Can the system be
|
||||
tested in parts? When failures are observed, can they be traced back
|
||||
|
@ -30,7 +30,7 @@
|
||||
|
||||
##### Related Documents:
|
||||
- [Software Requirements Specification](SRS)
|
||||
- [Release notes](release-notes.html)
|
||||
- [Release notes](Release-Notes)
|
||||
- [FAQ](faq.html)
|
||||
- [Glossary](Glossary)
|
||||
---
|
||||
|
@ -49,7 +49,7 @@ PRODUCT-NAME.
|
||||
|
||||
### Minimal System Requirements
|
||||
|
||||
::System requirements are described in the [release notes](release-notes.html).
|
||||
::System requirements are described in the [release notes](Release-Notes).
|
||||
|
||||
### Installation
|
||||
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [User Needs](user-needs.html) > Interview Notes
|
||||
# [User Needs](user-needs.html) > Interview Notes
|
||||
---
|
||||
|
||||
##### Project:
|
||||
@ -38,7 +38,7 @@
|
||||
::LOCATION
|
||||
|
||||
##### Related Documents:
|
||||
- [Project proposal](proposal.html) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [Project proposal](proposal.html) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [Interview checklist](interview-checklist.html)
|
||||
- [Glossary](Glossary)
|
||||
---
|
||||
|
4
Legal.md
4
Legal.md
@ -38,8 +38,8 @@
|
||||
::Commercial license
|
||||
|
||||
##### Related Documents:
|
||||
- [Project proposal](proposal.html) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [Plan](plan) > [Resource needs](Resource-Needs)
|
||||
- [Project proposal](proposal.html) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [Plan](plan) > [Resource needs](Resource-Needs)
|
||||
- [Glossary](Glossary)
|
||||
---
|
||||
|
||||
|
@ -5,11 +5,11 @@
|
||||
::STARTDATE - ENDDATE
|
||||
|
||||
##### Attached worksheets:
|
||||
- Plan > [Resource Needs](Resource-Needs)
|
||||
- Plan > [Resource Needs](Resource-Needs)
|
||||
|
||||
##### Related Documents:
|
||||
|
||||
- [Project Proposal](Proposal) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [Project Proposal](Proposal) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [Software development methodology](SDM)
|
||||
- [Glossary](Glossary)
|
||||
|
||||
@ -59,7 +59,7 @@ For a summary of this project, see the [Project proposal](proposal.html).
|
||||
|
||||
::THREE TO FIVE SENTENCES OR BULLETS HERE. COVER GENERAL APPROACH, IMPORTANT ASSUMPTIONS, KEY PRACTICES, AND PROJECT COORDINATION CONTROLS.
|
||||
|
||||
For more information see the [Software Development Methodology](sdm.html).
|
||||
For more information see the [Software Development Methodology](SDM).
|
||||
|
||||
#### How will the project team be organized?
|
||||
|
||||
|
50
QA-Plan.md
50
QA-Plan.md
@ -39,15 +39,15 @@ those answers that do not apply.*
|
||||
- ::Early access release (Controlled external access)
|
||||
|
||||
##### Attached Worksheets:
|
||||
- QA plan > [Review meeting notes](review-meeting-notes.html)
|
||||
- QA plan > [System test case suite](test-suite.html)
|
||||
- QA plan > [System test runs](test-run-suite.html)
|
||||
- QA plan > [Review meeting notes](review-meeting-notes.html)
|
||||
- QA plan > [System test case suite](test-suite.html)
|
||||
- QA plan > [System test runs](test-run-suite.html)
|
||||
|
||||
##### Related Documents:
|
||||
- [Software Requirements Specification](SRS)
|
||||
- [Design](Design)
|
||||
- [Project plan](Project-Plan)
|
||||
- [Software development methodology](sdm.html)
|
||||
- [Software development methodology](SDM)
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
- ::LINKS TO OTHER DOCUMENTS
|
||||
|
||||
@ -118,33 +118,33 @@ activities:
|
||||
that make sense for your project on this particular release.*
|
||||
|
||||
- ::Essential
|
||||
- [Functionality > Correctness](Glossary-Std#functionality_gt_correctness)
|
||||
- [Functionality > Robustness](Glossary-Std#functionality_gt_robustness)
|
||||
- [Functionality > Correctness](Glossary-Std#functionality_gt_correctness)
|
||||
- [Functionality > Robustness](Glossary-Std#functionality_gt_robustness)
|
||||
- ::Expected
|
||||
- [Functionality > Accuracy](Glossary-Std#functionality_gt_accuracy)
|
||||
- [Functionality > Compatibility](Glossary-Std#functionality_gt_compatibility)
|
||||
- [Functionality > Factual correctness](Glossary-Std#functionality_gt_factual_correctness)
|
||||
- [Usability > Understandability and Readability](Glossary-Std#usability_gt_understandability_and_readability)
|
||||
- [Usability > Learnability and Memorability](Glossary-Std#usability_gt_learnability_and_memorability)
|
||||
- [Usability > Task support](Glossary-Std#usability_gt_task_support)
|
||||
- [Usability > Efficiency](Glossary-Std#usability_gt_efficiency)
|
||||
- [Usability > Safety](Glossary-Std#usability_gt_safety)
|
||||
- [Usability > Consistency and Familiarity](Glossary-Std#usability_gt_consistency_and_familiarity)
|
||||
- [Usability > Subjective satisfaction](Glossary-Std#usability_gt_subjective_satisfaction)
|
||||
- [Functionality > Accuracy](Glossary-Std#functionality_gt_accuracy)
|
||||
- [Functionality > Compatibility](Glossary-Std#functionality_gt_compatibility)
|
||||
- [Functionality > Factual correctness](Glossary-Std#functionality_gt_factual_correctness)
|
||||
- [Usability > Understandability and Readability](Glossary-Std#usability_gt_understandability_and_readability)
|
||||
- [Usability > Learnability and Memorability](Glossary-Std#usability_gt_learnability_and_memorability)
|
||||
- [Usability > Task support](Glossary-Std#usability_gt_task_support)
|
||||
- [Usability > Efficiency](Glossary-Std#usability_gt_efficiency)
|
||||
- [Usability > Safety](Glossary-Std#usability_gt_safety)
|
||||
- [Usability > Consistency and Familiarity](Glossary-Std#usability_gt_consistency_and_familiarity)
|
||||
- [Usability > Subjective satisfaction](Glossary-Std#usability_gt_subjective_satisfaction)
|
||||
- [Security](Glossary-Std#security)
|
||||
- ::Desired
|
||||
- [Reliability > Consistency under load](Glossary-Std#reliability_gt_consistency_under_load)
|
||||
- [Reliability > Consistency under concurrency](Glossary-Std#reliability_gt_consistency_under_concurrency)
|
||||
- [Reliability > Availability under load](Glossary-Std#reliability_gt_availability_under_load)
|
||||
- [Reliability > Longevity](Glossary-Std#reliability_gt_longevity)
|
||||
- [Reliability > Consistency under load](Glossary-Std#reliability_gt_consistency_under_load)
|
||||
- [Reliability > Consistency under concurrency](Glossary-Std#reliability_gt_consistency_under_concurrency)
|
||||
- [Reliability > Availability under load](Glossary-Std#reliability_gt_availability_under_load)
|
||||
- [Reliability > Longevity](Glossary-Std#reliability_gt_longevity)
|
||||
- [Efficiency](Glossary-Std#efficiency)
|
||||
- [Scalability](Glossary-Std#scalability)
|
||||
- [Scalability > Performance under load](Glossary-Std#scalability_gt_performance_under_load)
|
||||
- [Scalability > Large data volume](Glossary-Std#scalability_gt_large_data_volume)
|
||||
- [Scalability > Performance under load](Glossary-Std#scalability_gt_performance_under_load)
|
||||
- [Scalability > Large data volume](Glossary-Std#scalability_gt_large_data_volume)
|
||||
- [Operability](Glossary-Std#operability)
|
||||
- [Maintainability > Understandability](Glossary-Std#maintainability_gt_understandability)
|
||||
- [Maintainability > Evolvability](Glossary-Std#maintainability_gt_evolvability)
|
||||
- [Maintainability > Testability](Glossary-Std#maintainability_gt_testability)
|
||||
- [Maintainability > Understandability](Glossary-Std#maintainability_gt_understandability)
|
||||
- [Maintainability > Evolvability](Glossary-Std#maintainability_gt_evolvability)
|
||||
- [Maintainability > Testability](Glossary-Std#maintainability_gt_testability)
|
||||
|
||||
### QA Strategy
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
|
||||
|
||||
# [Plan](Project-Plan) > Resource Needs
|
||||
# [Plan](Project-Plan) > Resource Needs
|
||||
---
|
||||
|
||||
##### Project:
|
||||
@ -16,7 +16,7 @@
|
||||
- [Project proposal](proposal.html)
|
||||
- [Project plan](Project-Plan)
|
||||
- [QA plan](qa-plan.html)
|
||||
- [Software development methodology](sdm.html)
|
||||
- [Software development methodology](SDM)
|
||||
- [Glossary](Glossary)
|
||||
---
|
||||
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [QA Plan](qa-plan.html) > Review Meeting Notes
|
||||
# [QA Plan](qa-plan.html) > Review Meeting Notes
|
||||
---
|
||||
|
||||
##### Project:
|
||||
|
2
Risks.md
2
Risks.md
@ -30,7 +30,7 @@
|
||||
|
||||
##### Related Documents:
|
||||
- [Project plan](Project-Plan)
|
||||
- [Software development methodology](sdm.html)
|
||||
- [Software development methodology](SDM)
|
||||
|
||||
##### References:
|
||||
- [Risk Management during Requirements](http://www.systemsguild.com/pdfs/s5req.lo%201.pdf) by Tom DeMarco and Tim Lister
|
||||
|
8
SRS.md
8
SRS.md
@ -29,8 +29,8 @@
|
||||
::X.Y.Z
|
||||
|
||||
##### Attached worksheets:
|
||||
- SRS > [Use case suite](use-case-suite.html)
|
||||
- SRS > [Feature set](feature-set.html)
|
||||
- SRS > [Use case suite](Use-Case-Suite)
|
||||
- SRS > [Feature set](Feature-Set)
|
||||
|
||||
##### Related Documents:
|
||||
- [Project proposal](proposal.html) > [User needs](user-needs.html)
|
||||
@ -64,7 +64,7 @@ For more information, see the project [proposal](proposal.html).
|
||||
Details:
|
||||
|
||||
- Actors are described in the [user needs](user-needs.html) document.
|
||||
- The [use case suite](use-case-suite.html) lists all use cases in an
|
||||
- The [use case suite](Use-Case-Suite) lists all use cases in an
|
||||
organized way.
|
||||
|
||||
### Functional Requirements
|
||||
@ -73,7 +73,7 @@ Details:
|
||||
|
||||
Details:
|
||||
|
||||
- The [feature set](feature-set.html) lists all features in an
|
||||
- The [feature set](Feature-Set) lists all features in an
|
||||
organized way.
|
||||
|
||||
### Non-Functional Requirements
|
||||
|
@ -71,7 +71,7 @@ examples are given, you should select/edit only one.*
|
||||
- ::Project canceled. This is the final status report.
|
||||
|
||||
##### Related Documents:
|
||||
- [Project plan](Project-Plan) > [Resource needs](Resource-Needs)
|
||||
- [Project plan](Project-Plan) > [Resource needs](Resource-Needs)
|
||||
- [QA plan](qa-plan.html)
|
||||
- [Glossary](Glossary)
|
||||
---
|
||||
|
@ -63,8 +63,8 @@ and [legal issues](legal.html) documents.*
|
||||
*TODO: Briefly describe the most important system requirements. This is
|
||||
condensed from the [user needs](user-needs.html),
|
||||
[interview notes](interview-notes.html), [SRS](SRS),
|
||||
[use case suite](use-case-suite.html),
|
||||
and [feature set](feature-set.html) documents.*
|
||||
[use case suite](Use-Case-Suite),
|
||||
and [feature set](Feature-Set) documents.*
|
||||
|
||||
#### Who are the project stakeholders?
|
||||
- ::PROJECT CHAMPION / EXECUTIVE SPONSOR
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [Proposal](proposal.html) > Target Audience and Benefits
|
||||
# [Proposal](proposal.html) > Target Audience and Benefits
|
||||
---
|
||||
|
||||
##### Project:
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [QA Plan](qa-plan.html) > [Test Suite](test-suite.html) > Test Case Format
|
||||
# [QA Plan](qa-plan.html) > [Test Suite](test-suite.html) > Test Case Format
|
||||
---
|
||||
|
||||
**Process impact:** This reference page documents the format of test
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [QA Plan](qa-plan) > [Test Suite](test-suite) > Test Cases
|
||||
# [QA Plan](qa-plan) > [Test Suite](test-suite) > Test Cases
|
||||
---
|
||||
|
||||
##### Project:
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [QA Plan](qa-plan.html) > Test Run Suite
|
||||
# [QA Plan](qa-plan.html) > Test Run Suite
|
||||
|
||||
---
|
||||
##### Project:
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [QA Plan](qa-plan.html) > [Test Run Suite](test-run-suite.html) > Test Runs
|
||||
# [QA Plan](qa-plan.html) > [Test Run Suite](test-run-suite.html) > Test Runs
|
||||
---
|
||||
|
||||
##### Project:
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [QA Plan](qa-plan.html) > Test Suite
|
||||
# [QA Plan](qa-plan.html) > Test Suite
|
||||
---
|
||||
|
||||
##### Project:
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [SRS](SRS) > [Use Case Suite](use-case-suite.html) > Use Case Format
|
||||
# [SRS](SRS) > [Use Case Suite](Use-Case-Suite) > Use Case Format
|
||||
---
|
||||
|
||||
**Process impact:** This reference page documents the format of use
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [SRS](SRS) > Use Case Suite
|
||||
# [SRS](SRS) > Use Case Suite
|
||||
---
|
||||
|
||||
##### Project:
|
||||
@ -30,7 +30,7 @@
|
||||
|
||||
##### Related Documents:
|
||||
- [Project proposal](proposal) > [User needs](user-needs)
|
||||
- [SRS](srs) > [Feature set](feature-set)
|
||||
- [SRS](SRS) > [Feature set](feature-set)
|
||||
- [Use case format](use-case-format)
|
||||
- ::LINK TO USE CASE DIAGRAM
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [SRS](srs) > [Use Case Suite](use-case-suite) > Use Cases
|
||||
# [SRS](SRS) > [Use Case Suite](use-case-suite) > Use Cases
|
||||
---
|
||||
|
||||
##### Project:
|
||||
@ -29,7 +29,7 @@
|
||||
::X.Y.Z
|
||||
|
||||
##### Related Documents:
|
||||
- [Project proposal](proposal.html) > [User needs](user-needs.html), [SRS](SRS) > [Feature set](feature-set.html)
|
||||
- [Project proposal](proposal.html) > [User needs](user-needs.html), [SRS](SRS) > [Feature set](Feature-Set)
|
||||
- [Use case format](use-case-format)
|
||||
- ::LINK TO USE CASE DIAGRAM
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
|
@ -26,10 +26,10 @@
|
||||
::[PROJECTNAME](Home)
|
||||
|
||||
##### Attached worksheets:
|
||||
- User needs > [Interview notes](interview-notes.html)
|
||||
- User needs > [Interview notes](interview-notes.html)
|
||||
|
||||
##### Related Documents:
|
||||
- [Project proposal](proposal.html) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [Project proposal](proposal.html) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [Software requirements specification](SRS)
|
||||
- [Glossary](Glossary)
|
||||
---
|
||||
@ -145,7 +145,7 @@ computer science.
|
||||
3. ::Understand the date and time of tournament play
|
||||
4. ::Easily report cheaters
|
||||
|
||||
#### ::Player > Advanced player
|
||||
#### ::Player > Advanced player
|
||||
|
||||
:: Advanced players seek more challenges to continue the sense
|
||||
of discovery. They tend to play over 20 hours a week. They have seen
|
||||
|
40
Workflows.md
40
Workflows.md
@ -11,14 +11,14 @@
|
||||
1. [User needs](user-needs.html)
|
||||
- [Interview notes](interview-notes.html)
|
||||
2. [Software Requirements Specification](SRS)
|
||||
- [Use case suite](use-case-suite.html)
|
||||
- [Feature set](feature-set.html)
|
||||
- [Use case suite](Use-Case-Suite)
|
||||
- [Feature set](Feature-Set)
|
||||
3. Architecture and Design
|
||||
1. [Design](Design)
|
||||
- [Architecture worksheet](Design-Architecture)
|
||||
- [Source and build](design-src-org.html)
|
||||
- [User interface worksheet](design-ui.html)
|
||||
- [Persistence worksheet](design-persistence.html)
|
||||
- [Source and build] > (Design-Src-Org)
|
||||
- [User interface worksheet](Design-UI)
|
||||
- [Persistence worksheet](Design-Persistence)
|
||||
- [Security worksheet](Design-Security)
|
||||
4. Implementation and Testing
|
||||
1. [User guide](userguide.html)
|
||||
@ -28,7 +28,7 @@
|
||||
5. Deployment and Installation
|
||||
1. [Release checklist](release-checklist.html)
|
||||
2. [Installation / Quick start guide](install.html)
|
||||
3. [Release notes](release-notes.html)
|
||||
3. [Release notes](Release-Notes)
|
||||
4. [Demo script](demo-script.html)
|
||||
6. Operations and Support
|
||||
1. [FAQ / Troubleshooting](faq.html)
|
||||
@ -37,7 +37,7 @@
|
||||
1. [Glossary](Glossary)
|
||||
2. [Status report](status-report.html)
|
||||
3. [Review meeting notes](review-meeting-notes.html)
|
||||
4. [Software development methodology](sdm.html)
|
||||
4. [Software development methodology](SDM)
|
||||
|
||||
### By Suggested Sequence
|
||||
1. Step 1
|
||||
@ -52,14 +52,14 @@
|
||||
1. [User needs](user-needs.html)
|
||||
- [Interview notes](interview-notes.html)
|
||||
2. [Software Requirements Specification](SRS)
|
||||
- [Use case suite](use-case-suite.html)
|
||||
- [Feature set](feature-set.html)
|
||||
- [Use case suite](Use-Case-Suite)
|
||||
- [Feature set](Feature-Set)
|
||||
3. Step 3
|
||||
1. [Design](Design)
|
||||
- [Architecture worksheet](Design-Architecture)
|
||||
- [Source and build](design-src-org.html)
|
||||
- [User interface worksheet](design-ui.html)
|
||||
- [Persistence worksheet](design-persistence.html)
|
||||
- [Source and build] > (Design-Src-Org)
|
||||
- [User interface worksheet](Design-UI)
|
||||
- [Persistence worksheet](Design-Persistence)
|
||||
- [Security worksheet](Design-Security)
|
||||
4. Step 4
|
||||
1. [QA Plan](qa-plan.html)
|
||||
@ -72,7 +72,7 @@
|
||||
1. [Release checklist](release-checklist.html)
|
||||
7. Step 7
|
||||
1. [Installation / Quick start guide](install.html)
|
||||
2. [Release notes](release-notes.html)
|
||||
2. [Release notes](Release-Notes)
|
||||
3. [User guide](userguide.html)
|
||||
4. [Demo script](demo-script.html)
|
||||
5. [FAQ / Troubleshooting](faq.html)
|
||||
@ -96,24 +96,24 @@
|
||||
7. [User needs](user-needs.html)
|
||||
- [Interview notes](interview-notes.html)
|
||||
8. [Software Requirements Specification](SRS)
|
||||
- [Use case suite](use-case-suite.html)
|
||||
- [Feature set](feature-set.html)
|
||||
- [Use case suite](Use-Case-Suite)
|
||||
- [Feature set](Feature-Set)
|
||||
9. [Glossary](Glossary)
|
||||
10. [Design](Design)
|
||||
- [Architecture worksheet](Design-Architecture)
|
||||
- [Source and build](design-src-org.html)
|
||||
- [User interface worksheet](design-ui.html)
|
||||
- [Persistence worksheet](design-persistence.html)
|
||||
- [Source and build] > (Design-Src-Org)
|
||||
- [User interface worksheet](Design-UI)
|
||||
- [Persistence worksheet](Design-Persistence)
|
||||
- [Security worksheet](Design-Security)
|
||||
11. [User guide](userguide.html)
|
||||
12. [Release checklist](release-checklist.html)
|
||||
13. [Installation / Quick start guide](install.html)
|
||||
14. [Release notes](release-notes.html)
|
||||
14. [Release notes](Release-Notes)
|
||||
15. [Demo script](demo-script.html)
|
||||
16. [FAQ / Troubleshooting](faq.html)
|
||||
17. [Implementation notes](implementation-notes.html)
|
||||
18. [Status report](status-report.html)
|
||||
19. [Software development methodology](sdm.html)
|
||||
19. [Software development methodology](SDM)
|
||||
|
||||
### How to download these templates:
|
||||
- [Download template archive](http://readyset.tigris.org/servlets/ProjectDocumentList), or
|
||||
|
Loading…
Reference in New Issue
Block a user