RWSCP/StartupStarterPackage
2
0
Fork 0
Code Pull Requests Packages Projects Releases Activity

fixed markdown links

Browse Source
This commit is contained in:
Charles N Wyble 2024-12-23 06:25:26 -06:00
parent 663e7aa487
commit 9d6e887540
62 changed files with 987 additions and 985 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/ProductPlan/Demo-Script.md
View File

@ -1,7 +1,7 @@
<!-- markdownlint-disable-next-line first-line-h1 --> <!-- markdownlint-disable-next-line first-line-h1 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -9,8 +9,8 @@
##### Related Documents ##### Related Documents
- [Project proposal](Proposal) > [Target audience and benefits](Target-and-Benefits) - [Project proposal](./Proposal.md) > [Target audience and benefits](./Target-and-Benefits.md)
- [SRS](SRS) > [Use case suite](Use-Case-Suite) - [SRS](./SRS.md) > [Use case suite](./Use-Case-Suite.md)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -93,7 +93,7 @@ disagree with any points?*
- ::KEY POINT - ::KEY POINT
- ::DEMO STEP - ::DEMO STEP
- ::DEMO STEP - ::DEMO STEP
- ::KEY POINT (if there is time) - ::KEY POINT (./if there is time.md)
- ::DEMO STEP - ::DEMO STEP
- ::DEMO STEP - ::DEMO STEP

52
src/ProductPlan/Design-Architecture.md
View File

@ -1,7 +1,7 @@
<!-- markdownlint-disable-next-line first-line-h1 --> <!-- markdownlint-disable-next-line first-line-h1 -->
##### Project ##### Project
::PROJECT-NAME(Home) ::PROJECT-NAME(./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -9,9 +9,9 @@
##### Related Documents ##### Related Documents
- [Design](Design) > Design Architecture - [Design](./Design.md) > Design Architecture
- [Software Requirements Specification](SRS) - [Software Requirements Specification](./SRS.md)
- [Glossary](Glossary) - [Glossary](./Glossary.md)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -28,7 +28,7 @@ architecture. Some example text is provided._
#### What software architecture style is being used? #### What software architecture style is being used?
- ::Single-process desktop application (with plug-in extension modules). - ::Single-process desktop application (./with plug-in extension modules.md).
- ::Client-server with a custom thick-clients and server. - ::Client-server with a custom thick-clients and server.
- ::2-tier web application: webserver/app-server, database. - ::2-tier web application: webserver/app-server, database.
- ::3-tier web application: webserver, app-server, database. - ::3-tier web application: webserver, app-server, database.
@ -40,57 +40,57 @@ architecture. Some example text is provided._
#### What are the ranked goals of this architecture? #### What are the ranked goals of this architecture?
1. ::[Ease of integration](Glossary-Standard-Terms#ease_of_integration) 1. ::[Ease of integration](./Glossary-Standard-Terms#ease_of_integration.md)
2. ::[Extensibility](Glossary-Standard-Terms#extensibility) 2. ::[Extensibility](./Glossary-Standard-Terms#extensibility.md)
3. ::[Capacity matching](Glossary-Standard-Terms#capacity_matching) 3. ::[Capacity matching](./Glossary-Standard-Terms#capacity_matching.md)
### Components ### Components
#### What are the components of this system? #### What are the components of this system?
::The components of this system are clearly defined in this [UML Model ::The components of this system are clearly defined in this [UML Model
with Component Diagram](LINK-TO-MODEL). with Component Diagram](./LINK-TO-MODEL.md).
::The components of this system are listed below by type: ::The components of this system are listed below by type:
- ::Presentation/UI Components - ::Presentation/UI Components
- ::[C-00: COMPONENT-NAME](Design-Components#c-00) - ::[C-00: COMPONENT-NAME](./Design-Components#c-00.md)
- ::Application Logic Components - ::Application Logic Components
- ::[C-10: COMPONENT-NAME](Design-Components#c-10) - ::[C-10: COMPONENT-NAME](./Design-Components#c-10.md)
- ::Data Storage Components - ::Data Storage Components
- ::[C-20: COMPONENT-NAME](Design-Components#c-20) - ::[C-20: COMPONENT-NAME](./Design-Components#c-20.md)
### Deployment ### Deployment
#### How will the components be deployed to processes and machines? #### How will the components be deployed to processes and machines?
::The deployment of components to processes and machines is clearly ::The deployment of components to processes and machines is clearly
defined in this [UML Model with Deployment Diagram](LINK-TO-MODEL). defined in this [UML Model with Deployment Diagram](./LINK-TO-MODEL.md).
::The deployment of components to processes and machines is clearly ::The deployment of components to processes and machines is clearly
defined below: defined below:
- ::All-in-one server - ::All-in-one server
- ::Tomcat process - ::Tomcat process
- ::[C-00: Tomcat web server](Design-Components#c-00) - ::[C-00: Tomcat web server](./Design-Components#c-00.md)
- ::[C-10: PROJECT-NAME - ::[C-10: PROJECT-NAME
application](Design-Components#c-10) application](./Design-Components#c-10.md)
- ::Database process - ::Database process
- ::[C-20: COMPONENT-NAME](Design-Components#c-30) - ::[C-20: COMPONENT-NAME](./Design-Components#c-30.md)
::The deployment of components to processes and machines is clearly ::The deployment of components to processes and machines is clearly
defined below: defined below:
- ::Load-balanced front-end servers - ::Load-balanced front-end servers
- ::[C-01: COMPONENT-NAME](Design-Components#c-00) - ::[C-01: COMPONENT-NAME](./Design-Components#c-00.md)
- ::Back-end server - ::Back-end server
- ::JVM process - ::JVM process
- ::[C-00: COMPONENT-NAME](Design-Components#c-00) - ::[C-00: COMPONENT-NAME](./Design-Components#c-00.md)
- ::[C-10: COMPONENT-NAME](Design-Components#c-10) - ::[C-10: COMPONENT-NAME](./Design-Components#c-10.md)
- ::[C-11: PLUG-IN COMPONENT-NAME](Design-Components#c-11) - ::[C-11: PLUG-IN COMPONENT-NAME](./Design-Components#c-11.md)
- ::[C-12: PLUG-IN COMPONENT-NAME](Design-Components#c-12) - ::[C-12: PLUG-IN COMPONENT-NAME](./Design-Components#c-12.md)
- Database process - Database process
- ::[C-20: COMPONENT-NAME](Design-Components#c-30) - ::[C-20: COMPONENT-NAME](./Design-Components#c-30.md)
#### What aspects/resources of their environment are shared? #### What aspects/resources of their environment are shared?
@ -161,9 +161,9 @@ fail-over._
The following sequence diagrams give step-by-step descriptions of how The following sequence diagrams give step-by-step descriptions of how
components communicate during some important usage scenarios: components communicate during some important usage scenarios:
- ::[System startup](LINK-TO-DIAGRAM) - ::[System startup](./LINK-TO-DIAGRAM.md)
- ::[System shutdown](LINK-TO-DIAGRAM) - ::[System shutdown](./LINK-TO-DIAGRAM.md)
- ::[SCENARIO NAME](LINK-TO-DIAGRAM) - ::[SCENARIO NAME](./LINK-TO-DIAGRAM.md)
### Architecture Checklist ### Architecture Checklist
@ -194,4 +194,4 @@ competition for resources.
::Yes, everyone understands. Feedback is welcome. ::Yes, everyone understands. Feedback is welcome.
::No, this is a risk that is noted in the [Risk Management](Project-Plan#Risk-Management) section. ::No, this is a risk that is noted in the [Risk Management](./Project-Plan#Risk-Management.md) section.

8
src/ProductPlan/Design-Components.md
View File

@ -9,7 +9,7 @@
##### Related Documents ##### Related Documents
- [Design](Design) > [Architecture](Design-Architecture) > Design Components - [Design](./Design.md) > [Architecture](./Design-Architecture.md) > Design Components
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -21,9 +21,9 @@ concerns that affect deployment options, and concurrency. Note key
aspects of each interface, but avoid duplicating details of interfaces aspects of each interface, but avoid duplicating details of interfaces
that are specified in the UML class diagrams or other documents._ that are specified in the UML class diagrams or other documents._
Each interface can be an API (application program interface), standard Each interface can be an API (./application program interface.md), standard
protocol (e.g., HTTP), config files, input data file format, or protocol (./e.g., HTTP.md), config files, input data file format, or
interactive user interface (e.g., command-line or GUI). One component interactive user interface (./e.g., command-line or GUI.md). One component
may have multiple interfaces: e.g., a server may handle requests in a may have multiple interfaces: e.g., a server may handle requests in a
standard protocol, but also have a config file, command-line options, an standard protocol, but also have a config file, command-line options, an
administrative control panel GUI, and a performance monitoring API. administrative control panel GUI, and a performance monitoring API.

32
src/ProductPlan/Design-Persistence.md
View File

@ -10,7 +10,7 @@
##### Related Documents ##### Related Documents
- [Design](Design) > Design Persistence - [Design](./Design.md) > Design Persistence
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -27,20 +27,20 @@ features. Some example text is provided. Add or delete text as needed._
#### What are the ranked goals for persistence in this system? #### What are the ranked goals for persistence in this system?
1. ::[Expressiveness](Glossary-Standard-Terms#dg_expressiveness) 1. ::[Expressiveness](./Glossary-Standard-Terms#dg_expressiveness.md)
2. ::[Ease of access](Glossary-Standard-Terms#dg_easy_access) 2. ::[Ease of access](./Glossary-Standard-Terms#dg_easy_access.md)
3. ::[Reliability](Glossary-Standard-Terms#dg_data_reliability) 3. ::[Reliability](./Glossary-Standard-Terms#dg_data_reliability.md)
4. ::[Data capacity](Glossary-Standard-Terms#dg_data_capacity) 4. ::[Data capacity](./Glossary-Standard-Terms#dg_data_capacity.md)
5. ::[Data security](Glossary-Standard-Terms#dg_data_security) 5. ::[Data security](./Glossary-Standard-Terms#dg_data_security.md)
6. ::[Performance](Glossary-Standard-Terms#dg_data_performance) 6. ::[Performance](./Glossary-Standard-Terms#dg_data_performance.md)
7. ::[Interoperability](Glossary-Standard-Terms#dg_data_interop) 7. ::[Interoperability](./Glossary-Standard-Terms#dg_data_interop.md)
### Central Database ### Central Database
#### What is the logical database design? #### What is the logical database design?
::The logical database design is described in this [UML ::The logical database design is described in this [UML
model](LINK-TO-MODEL) or this [ER diagram](LINK-TO-DIAGRAM). model](./LINK-TO-MODEL.md) or this [ER diagram](./LINK-TO-DIAGRAM.md).
::Additional logical constraints on the database are: ::Additional logical constraints on the database are:
@ -57,14 +57,14 @@ model](LINK-TO-MODEL) or this [ER diagram](LINK-TO-DIAGRAM).
#### What are the physical tables and views? #### What are the physical tables and views?
::The physical database design is described in this [UML ::The physical database design is described in this [UML
model](LINK-TO-MODEL) or this [ER diagram](LINK-TO-DIAGRAM). model](./LINK-TO-MODEL.md) or this [ER diagram](./LINK-TO-DIAGRAM.md).
#### How will objects in the application be stored in the database? #### How will objects in the application be stored in the database?
::We will use one database table for each class, and one row in the ::We will use one database table for each class, and one row in the
database for each persistent instance of that class. database for each persistent instance of that class.
::We will use a [library](LINK-TO-LIBRARY) to do our ::We will use a [library](./LINK-TO-LIBRARY.md) to do our
object-relational mapping. (E.g., torque, castor, JDO, object-relational mapping. (E.g., torque, castor, JDO,
ADO, hibernate) ADO, hibernate)
@ -127,13 +127,13 @@ user "daemon".
#### What file format will be used? #### What file format will be used?
::The [XYZ](LINK-TO-STANDARD) standard file format. ::The [XYZ](./LINK-TO-STANDARD.md) standard file format.
::A java .properties file. ::A java .properties file.
::A window's .ini file. ::A window's .ini file.
::An XML file using [this DTD file](LINK-TO-DTD). ::An XML file using [this DTD file](./LINK-TO-DTD.md).
::A simple text file with the following format: ... ::A simple text file with the following format: ...
@ -141,7 +141,7 @@ user "daemon".
### Distributed Storage ### Distributed Storage
#### What information (if any) will be stored on client machines? For how long? #### What information (./if any.md) will be stored on client machines? For how long?
::A cookie will be stored on the user machine for the purpose of ::A cookie will be stored on the user machine for the purpose of
identifying a user session. When the user logs out or closes their identifying a user session. When the user logs out or closes their
@ -149,7 +149,7 @@ web browser, the cookie is deleted. Most browsers will not even
write this cookie to the disk. write this cookie to the disk.
::The a cookie is stored on the user's computer that is equivalent to ::The a cookie is stored on the user's computer that is equivalent to
their password (but it is NOT actually their password). This cookie their password (./but it is NOT actually their password.md). This cookie
is needed for the auto-login feature. The cookie lasts a maximum of is needed for the auto-login feature. The cookie lasts a maximum of
30 days, and it can only be used from the same IP address. 30 days, and it can only be used from the same IP address.
@ -193,5 +193,5 @@ kept indefinitely.
::Yes, everyone understands. Feedback is welcome. ::Yes, everyone understands. Feedback is welcome.
::No, this is a risk that is noted in the [Risk Management](Project-Plan#Risk-Management) ::No, this is a risk that is noted in the [Risk Management](./Project-Plan#Risk-Management.md)
section. section.

8
src/ProductPlan/Design-Scalability.md
View File

@ -10,7 +10,7 @@
##### Related Documents ##### Related Documents
- [Design](Design) > Scalability - [Design](./Design.md) > Scalability
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -38,8 +38,8 @@ scalability goals for this design._
| Action | Goal | Time Formula | Description | | Action | Goal | Time Formula | Description |
| ------------- | ------------ | --------------------------- | --------------------------------------------------------------------------- | | ------------- | ------------ | --------------------------- | --------------------------------------------------------------------------- |
| ::login | ::1 second | ::O(Log(registered_users)) | ::Time that it takes to look up a user by their login name in the database. | | ::login | ::1 second | ::O(./Log(registered_users.md)) | ::Time that it takes to look up a user by their login name in the database. |
| ::display_map | ::1/5 second | ::O(map_size + game_pieces) | ::Time that it takes to redraw the game map and all game pieces. | | ::display_map | ::1/5 second | ::O(./map_size + game_pieces.md) | ::Time that it takes to redraw the game map and all game pieces. |
### System Scalability Checklist ### System Scalability Checklist
@ -52,4 +52,4 @@ How well do these mechanisms support the achievement of your goals?
::Yes, everyone understands. Feedback is welcome. ::Yes, everyone understands. Feedback is welcome.
::No, this is a risk that is noted in the ::No, this is a risk that is noted in the
[Risk Management](Project-Plan#Risk-Management) section. [Risk Management](./Project-Plan#Risk-Management.md) section.

28
src/ProductPlan/Design-Security.md
View File

@ -10,7 +10,7 @@
##### Related Documents ##### Related Documents
- [Design](Design) > Design Security - [Design](./Design.md) > Design Security
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -26,10 +26,10 @@ _TODO: Answer the questions below to help you design needed security features. S
#### What are the ranked goals for security in this system? #### What are the ranked goals for security in this system?
1. ::[Data security](Glossary-Standard-Terms#data_security) 1. ::[Data security](./Glossary-Standard-Terms#data_security.md)
2. ::[Intrusion prevention](Glossary-Standard-Terms#intrusion_prevention) 2. ::[Intrusion prevention](./Glossary-Standard-Terms#intrusion_prevention.md)
3. ::[Abuse prevention](Glossary-Standard-Terms#abuse_prevention) 3. ::[Abuse prevention](./Glossary-Standard-Terms#abuse_prevention.md)
4. ::[Auditability](Glossary-Standard-Terms#auditability) 4. ::[Auditability](./Glossary-Standard-Terms#auditability.md)
### Security Mechanisms ### Security Mechanisms
@ -55,10 +55,10 @@ _TODO: Answer the questions below to help you design needed security features. S
- ::Users can only connect to the server from specific ranges of - ::Users can only connect to the server from specific ranges of
IP-address (e.g., university-owned computers in networks IP-address (e.g., university-owned computers in networks
on campus). on campus).
- ::Certain users (e.g., administrators) can only connect from - ::Certain users (./e.g., administrators.md) can only connect from
specific ranges of IP-addresses. specific ranges of IP-addresses.
- ::All network communication takes place over a virtual private - ::All network communication takes place over a virtual private
network (VPN) that is encrypted and not accessible to outsiders. network (./VPN.md) that is encrypted and not accessible to outsiders.
- ::All network communication takes place over a LAN that does not - ::All network communication takes place over a LAN that does not
have any connections to the Internet. have any connections to the Internet.
@ -99,14 +99,14 @@ _TODO: Answer the questions below to help you design needed security features. S
- ::Guest: Visitor to the site is not logged in, can post messages anonymously - ::Guest: Visitor to the site is not logged in, can post messages anonymously
- ::RegisteredUser: User is logged in, has permissions for X, Y, and Z - ::RegisteredUser: User is logged in, has permissions for X, Y, and Z
- ::Administrator: Permission to change anything, even on behalf of other regular users - ::Administrator: Permission to change anything, even on behalf of other regular users
- ::Each action (information display or change) requires that the - ::Each action (./information display or change.md) requires that the
user has a role with proper permissions user has a role with proper permissions
- ::Compromised or abused accounts can be quickly disabled by administrators. - ::Compromised or abused accounts can be quickly disabled by administrators.
- ::Administrators can review user permissions - ::Administrators can review user permissions
- ::Administrators can audit all accesses and changes - ::Administrators can audit all accesses and changes
- ::All communications with the user are encrypted (e.g., SSL) - ::All communications with the user are encrypted (./e.g., SSL.md)
- ::Some communications with the user (e.g., the username - ::Some communications with the user (e.g., the username
and password) are encrypted (e.g., SSL) and password) are encrypted (./e.g., SSL.md)
- ::Sessions are tied to a particular client IP-address so that - ::Sessions are tied to a particular client IP-address so that
stolen cookies cannot be used. stolen cookies cannot be used.
- ::Session cookies are long random strings that cannot be guessed. - ::Session cookies are long random strings that cannot be guessed.
@ -115,10 +115,10 @@ _TODO: Answer the questions below to help you design needed security features. S
where it can still be reviewed by administrators. where it can still be reviewed by administrators.
- ::Sensitive data, such as credit card numbers, are processed but - ::Sensitive data, such as credit card numbers, are processed but
not retained in any database or file not retained in any database or file
- ::The data access layer will be responsible for preventing SQL injection attacks (i.e., hackers attempting to enter SQL statements through application UI fields). - ::The data access layer will be responsible for preventing SQL injection attacks (./i.e., hackers attempting to enter SQL statements through application UI fields.md).
- ::The data access layer will allow read-only connections, which will be used for most requests, as well as write connections for requests that update the database. - ::The data access layer will allow read-only connections, which will be used for most requests, as well as write connections for requests that update the database.
- ::The HTML generation layer will be responsible for preventing cross-site-scripting (XSS) attacks. - ::The HTML generation layer will be responsible for preventing cross-site-scripting (./XSS.md) attacks.
- ::The application will prevent Cross-Site Request Forgery (CSRF) attacks. It will do this by performing updates to the database only after a POST, and checking that the referring page was served by the system for every POST. Browsers that do not report HTTP-Referrer will not be supported. - ::The application will prevent Cross-Site Request Forgery (./CSRF.md) attacks. It will do this by performing updates to the database only after a POST, and checking that the referring page was served by the system for every POST. Browsers that do not report HTTP-Referrer will not be supported.
### Security Checklist ### Security Checklist
@ -142,4 +142,4 @@ _TODO: Answer the questions below to help you design needed security features. S
::Yes, everyone understands. Feedback is welcome. ::Yes, everyone understands. Feedback is welcome.
::No, this is a risk that is noted in the [Risk Management](Project-Plan#Risk-Management) section. ::No, this is a risk that is noted in the [Risk Management](./Project-Plan#Risk-Management.md) section.

10
src/ProductPlan/Design-Src-Org.md
View File

@ -10,9 +10,9 @@
##### Related Documents ##### Related Documents
- [Design](Design) > Source Code Organization and Build System - [Design](./Design.md) > Source Code Organization and Build System
- ::[Example build.xml for Tomcat](http://jakarta.apache.org/tomcat/tomcat-4.1-doc/appdev/build.xml.txt) - ::[Example build.xml for Tomcat](./http://jakarta.apache.org/tomcat/tomcat-4.1-doc/appdev/build.xml.txt.md)
- ::[Apache Ant manual](http://ant.apache.org/manual/index) - ::[Apache Ant manual](./http://ant.apache.org/manual/index.md)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -61,7 +61,7 @@ overall structure or build process._
| ::data/ | ::Yes | ::Initial data to load into database and/or file system, if any | | ::data/ | ::Yes | ::Initial data to load into database and/or file system, if any |
| ::lib/ | ::Yes | ::Libraries reused by this project, if any | | ::lib/ | ::Yes | ::Libraries reused by this project, if any |
| ::scripts/ | ::Yes | ::Command-line utility scripts used by this project, if any | | ::scripts/ | ::Yes | ::Command-line utility scripts used by this project, if any |
| ::www/ | ::Yes | ::Project documents (e.g., overview, plan, requirements, and design) | | ::www/ | ::Yes | ::Project documents (./e.g., overview, plan, requirements, and design.md) |
| ::build/ | ::No | ::Output of build process | | ::build/ | ::No | ::Output of build process |
| ::build/WEB-INF/classes/ | ::No | ::Compiled code output by build process | | ::build/WEB-INF/classes/ | ::No | ::Compiled code output by build process |
| ::dist/docs/api/ | ::No | ::API documentation output from build process | | ::dist/docs/api/ | ::No | ::API documentation output from build process |
@ -125,4 +125,4 @@ aimed at specific platforms.
::Yes, everyone understands. Feedback is welcome. ::Yes, everyone understands. Feedback is welcome.
::No, this is a risk that is noted in the [Risk Management](Project-Plan#Risk-Management) section. ::No, this is a risk that is noted in the [Risk Management](./Project-Plan#Risk-Management.md) section.

44
src/ProductPlan/Design-UI.md
View File

@ -10,7 +10,7 @@
##### Related Documents ##### Related Documents
- [Design](Design) > User Interface - [Design](./Design.md) > User Interface
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -28,10 +28,10 @@ text as needed._
#### What are the ranked goals for the user interface of this system? #### What are the ranked goals for the user interface of this system?
1. ::[Understandability and learnability](Glossary-Standard-Terms#understandability_and_learnability) 1. ::[Understandability and learnability](./Glossary-Standard-Terms#understandability_and_learnability.md)
2. ::[Task support and efficiency](Glossary-Standard-Terms#task_support_and_efficiency) 2. ::[Task support and efficiency](./Glossary-Standard-Terms#task_support_and_efficiency.md)
3. ::[Safety](Glossary-Standard-Terms#safety) 3. ::[Safety](./Glossary-Standard-Terms#safety.md)
4. ::[Consistency and familiarity](Glossary-Standard-Terms#consistency_and_familiarity) 4. ::[Consistency and familiarity](./Glossary-Standard-Terms#consistency_and_familiarity.md)
### Metaphors, Exemplars, and Standards ### Metaphors, Exemplars, and Standards
@ -41,28 +41,28 @@ text as needed._
#### What existing systems have user interfaces similar to the UI you want to build? What specific aspects are similar? #### What existing systems have user interfaces similar to the UI you want to build? What specific aspects are similar?
- ::[amazon.com](http://www.amazon.com): Our e-commerce site will - ::[amazon.com](./http://www.amazon.com.md): Our e-commerce site will
have stores and departments, and search like this site. have stores and departments, and search like this site.
- ::[Microsoft Office](http://www.microsoft.com/office/using/default.asp): We - ::[Microsoft Office](./http://www.microsoft.com/office/using/default.asp.md): We
will use configurable toolbars the same way Office 2000 does. will use configurable toolbars the same way Office 2000 does.
- ::[EXISTING-UI](LINK-TO-SYSTEM): DESCRIPTION - ::[EXISTING-UI](./LINK-TO-SYSTEM.md): DESCRIPTION
#### What UI design standards, guidelines, and styles are you following? #### What UI design standards, guidelines, and styles are you following?
- ::[Microsoft UI guidelines](http://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.md)
- ::[Java UI guidelines](http://java.sun.com/products/jlf/ed1/guidelines.html) - ::[Java UI guidelines](./http://java.sun.com/products/jlf/ed1/guidelines.html.md)
- ::[Mac UI guidelines](http://developer.apple.com/techpubs/macosx/Essentials/AquaHIGuidelines/AHIGHIGs/index.html) - ::[Mac UI guidelines](./http://developer.apple.com/techpubs/macosx/Essentials/AquaHIGuidelines/AHIGHIGs/index.html.md)
- ::[W3C Accessibility guidelines](http://www.w3.org/TR/WCAG10/) - ::[W3C Accessibility guidelines](./http://www.w3.org/TR/WCAG10/.md)
### Task Models ### Task Models
#### What types of users will use this system? #### What types of users will use this system?
::See the [user needs document](User-Needs). ::See the [user needs document](./User-Needs.md).
#### What types of tasks will those users perform? #### What types of tasks will those users perform?
::See the [use case suite](Use-Case-Suite). ::See the [use case suite](./Use-Case-Suite.md).
### Content Model / Interaction Contexts ### Content Model / Interaction Contexts
@ -84,7 +84,7 @@ that context. Each component is a piece of information, or a user
interface affordance. In a GUI, each abstract component will eventually interface affordance. In a GUI, each abstract component will eventually
become a widget, but the choice of specific widgets happens later. become a widget, but the choice of specific widgets happens later.
Choice of abstract components corresponds to step 2 in the Choice of abstract components corresponds to step 2 in the
[HTML prototyping example](http://www.ics.uci.edu/~jrobbins/htmlproto/index.html) [HTML prototyping example](./http://www.ics.uci.edu/~jrobbins/htmlproto/index.html.md)
demonstrated in class._ demonstrated in class._
_TIP: Most high frequency use cases should be carried out in only one _TIP: Most high frequency use cases should be carried out in only one
@ -94,29 +94,29 @@ many components can also be hard to use._
| Interaction Context --Abstract UI Components | Purpose | Contents / Constraints / Behavior | | Interaction Context --Abstract UI Components | Purpose | Contents / Constraints / Behavior |
| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ::[Login dialog](LINK-TO-MOCKUP) | ::Verify that the current user is actually the person that they claim to be. | | | ::[Login dialog](./LINK-TO-MOCKUP.md) | ::Verify that the current user is actually the person that they claim to be. | |
| ::--Prompt | ::Tell the user that this dialog is to log in. | ::"Please log in". | | ::--Prompt | ::Tell the user that this dialog is to log in. | ::"Please log in". |
| ::--Message area | ::Give the user some feedback about the login process. | ::Initially blank. Changes to "Checking username and password" when the user presses "Login". Changes to "Invalid username or password, please try again", if login fails. | | ::--Message area | ::Give the user some feedback about the login process. | ::Initially blank. Changes to "Checking username and password" when the user presses "Login". Changes to "Invalid username or password, please try again", if login fails. |
| ::--Username | ::Identify the user account that the current user is trying to access. | ::The name of the user account. Regex: [-_a-z0-9]{1-16}. The application should not do anything that would help users guess usernames. E.g., this should not be a combo-box with recent users listed, and it should not offer auto-complete. | | ::--Username | ::Identify the user account that the current user is trying to access. | ::The name of the user account. Regex: [-_a-z0-9]{1-16}. The application should not do anything that would help users guess usernames. E.g., this should not be a combo-box with recent users listed, and it should not offer auto-complete. |
| ::--Password | ::Verify that the current user knows a secret password that only the true user of that user account should know. | ::The password of 4-16 characters. Do not display the password on the screen. The application should not do anything that would help users guess passwords. | | ::--Password | ::Verify that the current user knows a secret password that only the true user of that user account should know. | ::The password of 4-16 characters. Do not display the password on the screen. The application should not do anything that would help users guess passwords. |
| ::--Login | ::Allow the user to indicate that they have completed entry of their username and password. | ::"Login" Only enabled when Username != "". If the username or password is incorrect, delay a few seconds, and then clear all fields. | | ::--Login | ::Allow the user to indicate that they have completed entry of their username and password. | ::"Login" Only enabled when Username != "". If the username or password is incorrect, delay a few seconds, and then clear all fields. |
| ::--Lost Password | ::Allow the current user to start a process of generating a new password for a given username. | ::"Forgot your password? Click here." Only enabled when Username != "". | | ::--Lost Password | ::Allow the current user to start a process of generating a new password for a given username. | ::"Forgot your password? Click here." Only enabled when Username != "". |
| ::[PAGE-NAME](LINK-TO-MOCKUP) | ::PURPOSE | | | ::[PAGE-NAME](./LINK-TO-MOCKUP.md) | ::PURPOSE | |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::[PAGE-NAME](LINK-TO-MOCKUP) | ::PURPOSE | | | ::[PAGE-NAME](./LINK-TO-MOCKUP.md) | ::PURPOSE | |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::[MAIN-WINDOW-NAME](LINK-TO-MOCKUP) | ::PURPOSE | | | ::[MAIN-WINDOW-NAME](./LINK-TO-MOCKUP.md) | ::PURPOSE | |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::[DIALOG-NAME](LINK-TO-MOCKUP) | ::PURPOSE | | | ::[DIALOG-NAME](./LINK-TO-MOCKUP.md) | ::PURPOSE | |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::[DIALOG-NAME](LINK-TO-MOCKUP) | ::PURPOSE | | | ::[DIALOG-NAME](./LINK-TO-MOCKUP.md) | ::PURPOSE | |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS | | ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
@ -126,7 +126,7 @@ many components can also be hard to use._
#### What are your assumptions about the output devices? #### What are your assumptions about the output devices?
::We assume that the user has a 17-inch or larger screen with 1024x768 ::We assume that the user has a 17-inch or larger screen with 1024x768
pixels that can display thousands of colors (16 bit or more). We pixels that can display thousands of colors (./16 bit or more.md). We
assume basic audio that can play simple sound files. assume basic audio that can play simple sound files.
::We make very few assumptions about the user's screen or web browser, ::We make very few assumptions about the user's screen or web browser,

72
src/ProductPlan/Design.md
View File

@ -2,7 +2,7 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](././Home.md.md)
##### Internal Release Number ##### Internal Release Number
@ -10,18 +10,18 @@
##### Attached Worksheets ##### Attached Worksheets
- Design > [Architecture Worksheet](Design-Architecture) - Design > [Architecture Worksheet](././Design-Architecture.md.md)
- Design > [Source Organization and Build Worksheet](Design-Src-Org) - Design > [Source Organization and Build Worksheet](././Design-Src-Org.md.md)
- Design > [Scalability Worksheet](Design-Scalability) - Design > [Scalability Worksheet](././Design-Scalability.md.md)
- Design > [User Interface Worksheet](Design-UI) - Design > [User Interface Worksheet](././Design-UI.md.md)
- Design > [Persistent Storage Worksheet](Design-Persistence) - Design > [Persistent Storage Worksheet](././Design-Persistence.md.md)
- Design > [Security Worksheet](Design-Security) - Design > [Security Worksheet](././Design-Security.md.md)
##### Related Documents ##### Related Documents
- [SRS](SRS) > [Use case suite](Use-Case-Suite) - [SRS](././SRS.md.md) > [Use case suite](././Use-Case-Suite.md.md)
- [SRS](SRS) > [Feature set](Feature-Set) - [SRS](././SRS.md.md) > [Feature set](././Feature-Set.md.md)
- [Glossary](Glossary) - [Glossary](././Glossary.md.md)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -29,7 +29,7 @@
**Process impact:** **Process impact:**
This design document describes a system that will satisfy the requirements of the [SRS](SRS). Decisions made in creating this design document are based on those requirements and an understanding of available technologies and components. Once the design has been drafted, work on the system implementation and unit testing may begin. This design document describes a system that will satisfy the requirements of the [SRS](././SRS.md.md). Decisions made in creating this design document are based on those requirements and an understanding of available technologies and components. Once the design has been drafted, work on the system implementation and unit testing may begin.
_TODO: Fill in the sections below. Add ore remove items as needed for your project._ _TODO: Fill in the sections below. Add ore remove items as needed for your project._
@ -48,14 +48,14 @@ interface and database design.
#### What are the prioritized goals of this design? #### What are the prioritized goals of this design?
1. ::[Correctness](Glossary-Standard-Terms#correctness) 1. ::[Correctness](././Glossary-Standard-Terms#correctness.md.md)
2. ::[Feasibility](Glossary-Standard-Terms#feasibility) 2. ::[Feasibility](././Glossary-Standard-Terms#feasibility.md.md)
3. ::[Understandability](Glossary-Standard-Terms#understandability) 3. ::[Understandability](././Glossary-Standard-Terms#understandability.md.md)
4. ::[Implementation phase guidance](Glossary-Standard-Terms#implementation-and-phase-guidance) 4. ::[Implementation phase guidance](././Glossary-Standard-Terms#implementation-and-phase-guidance.md.md)
5. ::[Modularity](Glossary-Standard-Terms#modularity) 5. ::[Modularity](././Glossary-Standard-Terms#modularity.md.md)
6. ::[Extensibility](Glossary-Standard-Terms#extensibility) 6. ::[Extensibility](././Glossary-Standard-Terms#extensibility.md.md)
7. ::[Testability](Glossary-Standard-Terms#testability) 7. ::[Testability](././Glossary-Standard-Terms#testability.md.md)
8. ::[Efficiency](Glossary-Standard-Terms#efficiency) 8. ::[Efficiency](././Glossary-Standard-Terms#efficiency.md.md)
### UML Structural Design ### UML Structural Design
@ -64,18 +64,18 @@ system's structure in detail._
#### The system's structural design is described in the following UML model #### The system's structural design is described in the following UML model
::[MODEL-NAME](LINK-TO-MODEL-FILE). ::[MODEL-NAME](././LINK-TO-MODEL-FILE.md.md).
#### The system's structural design is described in the following UML structural diagrams #### The system's structural design is described in the following UML structural diagrams
- ::[PACKAGE OVERVIEW DIAGRAM](LINK-TO-DIAGRAM) - ::[PACKAGE OVERVIEW DIAGRAM](././LINK-TO-DIAGRAM.md.md)
- ::PACKAGE-NAME - ::PACKAGE-NAME
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
- ::PACKAGE-NAME - ::PACKAGE-NAME
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
- ::PACKAGE-NAME - ::PACKAGE-NAME
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
::ANY ADDITIONAL NOTES OR COMMENTS ::ANY ADDITIONAL NOTES OR COMMENTS
@ -86,22 +86,22 @@ system's behavior in detail._
#### The system's behavioral design is described in the following UML model #### The system's behavioral design is described in the following UML model
::[MODEL-NAME](LINK-TO-MODEL-FILE) ::[MODEL-NAME](././LINK-TO-MODEL-FILE.md.md)
#### The system's behavioral design is described in the following UML behavioral diagrams #### The system's behavioral design is described in the following UML behavioral diagrams
- State Diagrams - State Diagrams
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
- Sequence Diagrams - Sequence Diagrams
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
- Collaboration Diagrams - Collaboration Diagrams
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
- ::[DIAGRAM-NAME](LINK-TO-DIAGRAM) - ::[DIAGRAM-NAME](././LINK-TO-DIAGRAM.md.md)
::ANY ADDITIONAL NOTES OR COMMENTS ::ANY ADDITIONAL NOTES OR COMMENTS
@ -148,4 +148,4 @@ revised._
- ::Yes, everyone understands. Feedback is welcome. - ::Yes, everyone understands. Feedback is welcome.
- ::No, this is a risk that is noted in the - ::No, this is a risk that is noted in the
[Risk Management](Project-Plan#Risk-Management) section. [Risk Management](././Project-Plan#Risk-Management.md.md) section.

18
src/ProductPlan/Document-Cross-Ref.md
View File

@ -11,12 +11,12 @@ the software development workflow.
| Read By \ Written By | Everyone | Project Manager | Product Manager | Dev Team | QA Team | Tech Writer | Tech Support | Operations | Sales | | Read By \ Written By | Everyone | Project Manager | Product Manager | Dev Team | QA Team | Tech Writer | Tech Support | Operations | Sales |
| -------------------- | -------------------------------------------------- | ------------------------------------------------------------------------ | ---------------------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------------------------------------------------- | -------------- | ---------- | -------------------------- | | -------------------- | -------------------------------------------------- | ------------------------------------------------------------------------ | ---------------------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------------------------------------------------- | -------------- | ---------- | -------------------------- |
| Everyone | [Release-Checklist](Release-Checklist), [SDM](SDM) | [Overview](Overview), [Proposal](Proposal), [Plan](Plan), [Risks](Risks) | [SRS](SRS) | Mockups, Prototyes, Working-product | | [User-Guide](User-Guide), [Release-Notes](Release-Notes) | | | | | Everyone | [Release-Checklist](./Release-Checklist.md), [SDM](./SDM.md) | [Overview](./Overview.md), [Proposal](./Proposal.md), [Plan](./Plan.md), [Risks](./Risks.md) | [SRS](./SRS.md) | Mockups, Prototyes, Working-product | | [User-Guide](./User-Guide.md), [Release-Notes](./Release-Notes.md) | | | |
| Project Manager | [Status-Report](Status-Report) | [Resource-Needs](Resource-Needs) | | [Review-Report](Review-Report) | [QA-Plan](QA-Plan), [Test-Runs](Test-Runs), Defect-reports | | Support-issues | | Customer-feedback | | Project Manager | [Status-Report](./Status-Report.md) | [Resource-Needs](./Resource-Needs.md) | | [Review-Report](./Review-Report.md) | [QA-Plan](./QA-Plan.md), [Test-Runs](./Test-Runs.md), Defect-reports | | Support-issues | | Customer-feedback |
| Product Manager | | | [User-Needs](User-Needs) | | | | Support-issues | | Customer-feedback | | Product Manager | | | [User-Needs](./User-Needs.md) | | | | Support-issues | | Customer-feedback |
| Dev Team | | Task-assignments | | [Design](Design) | [QA-Plan](QA-Plan), [Test-Runs](Test-Runs), Defect-reports | | | | | | Dev Team | | Task-assignments | | [Design](./Design.md) | [QA-Plan](./QA-Plan.md), [Test-Runs](./Test-Runs.md), Defect-reports | | | | |
| QA Team | | Task-assignments | | [Design](Design), [Status-Report](Status-Report) | [QA-Plan](QA-Plan), [Test-Suite](Test-Suite), Defect-reports | [FAQ](FAQ), [Install](Install) | Support-issues | | | | QA Team | | Task-assignments | | [Design](./Design.md), [Status-Report](./Status-Report.md) | [QA-Plan](./QA-Plan.md), [Test-Suite](./Test-Suite.md), Defect-reports | [FAQ](./FAQ.md), [Install](./Install.md) | Support-issues | | |
| Tech Writer | | Task-assignments | [User-Needs](User-Needs) | [Design-UI](Design-UI) | | | Support-issues | | Customer-feedback | | Tech Writer | | Task-assignments | [User-Needs](./User-Needs.md) | [Design-UI](./Design-UI.md) | | | Support-issues | | Customer-feedback |
| Tech Support | | | | [Design-UI](Design-UI) | | | Support-issues | | Customer-feedback | | Tech Support | | | | [Design-UI](./Design-UI.md) | | | Support-issues | | Customer-feedback |
| Operations | | | [User-Needs](User-Needs) | [Design-Architecture](Design-Architecture), [Implementation-Notes](Implementation-Notes) | | [Install](Install) | | | | | Operations | | | [User-Needs](./User-Needs.md) | [Design-Architecture](./Design-Architecture.md), [Implementation-Notes](./Implementation-Notes.md) | | [Install](./Install.md) | | | |
| Sales | | | [User-Needs](User-Needs), [Demo-Script](Demo-Script) | [Implementation-Notes](Implementation-Notes) | | [Install](Install) | | | [Demo-Script](Demo-Script) | | Sales | | | [User-Needs](./User-Needs.md), [Demo-Script](./Demo-Script.md) | [Implementation-Notes](./Implementation-Notes.md) | | [Install](./Install.md) | | | [Demo-Script](./Demo-Script.md) |

30
src/ProductPlan/FAQ.md
View File

@ -12,23 +12,23 @@ contributors, members of a developers' network, or administrators._
#### What is ::PRODUCT-NAME? #### What is ::PRODUCT-NAME?
::It is a XXXXX. Read our [PRODUCT-NAME overview](http://www.COMPANY.com/products/PRODUCT-NAME/). ::It is a XXXXX. Read our [PRODUCT-NAME overview](./http://www.COMPANY.com/products/PRODUCT-NAME/.md).
#### Who should use ::PRODUCT-NAME? #### Who should use ::PRODUCT-NAME?
::Anyone who wants XXXXXXX. Read more about our [target audience and benefits](Target-and-Benefits). ::Anyone who wants XXXXXXX. Read more about our [target audience and benefits](./Target-and-Benefits.md).
### Download and Install ### Download and Install
#### How can I obtain ::PRODUCT-NAME? #### How can I obtain ::PRODUCT-NAME?
::You may [download PRODUCT-NAME](LINK-TO-DOWNLOAD). ::You may [download PRODUCT-NAME](./LINK-TO-DOWNLOAD.md).
::You may [place an order for PRODUCT-NAME](LINK-TO-ORDER). ::You may [place an order for PRODUCT-NAME](./LINK-TO-ORDER.md).
#### What do I need to use ::PRODUCT-NAME? #### What do I need to use ::PRODUCT-NAME?
::System requirements are described in the [release notes](Release-Notes). ::System requirements are described in the [release notes](./Release-Notes.md).
::System requirements are a Intel-compatible PC with a processor speed ::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 of at least XXX MHz, XXX MB of RAM. XXX MB of free disk space, and
@ -37,18 +37,18 @@ OSX, Linux.
#### How do I install ::PRODUCT-NAME? #### How do I install ::PRODUCT-NAME?
::[Installation instructions](install.html) are available on-line. ::[Installation instructions](./install.html.md) are available on-line.
#### How do I upgrade from an older version of PRODUCT-NAME? #### How do I upgrade from an older version of PRODUCT-NAME?
::[Installation instructions](install.html) are available on-line. ::[Installation instructions](./install.html.md) are available on-line.
### Getting Started ### Getting Started
#### What is ::TECHNICAL-TERM? #### What is ::TECHNICAL-TERM?
::It means XXXXX. For additional technical terms, see the ::It means XXXXX. For additional technical terms, see the
[glossary](Glossary). [glossary](./Glossary.md).
#### What is ::GUI-ELEMENT? #### What is ::GUI-ELEMENT?
@ -94,14 +94,14 @@ OSX, Linux.
#### My question is not on this page. How do I find the answer? #### 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.md) and other
on-line help. Your question may have already been asked and on-line help. Your question may have already been asked and
answered, to find it: search the project [mail archives](::tbd) and answered, to find it: search the project [mail archives](./::tbd.md) and
[issue tracking system](::tbd). If you still don't find it, you can ask [issue tracking system](./::tbd.md). If you still don't find it, you can ask
the question on the [users' mailing list](::tbd) or the [developers' the question on the [users' mailing list](./::tbd.md) or the [developers'
mailing list](::tbd) or you can [enter an issue](::tbd). mailing list](./::tbd.md) or you can [enter an issue](./::tbd.md).
#### Where should I send comments on this FAQ? #### 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:#.md) or any of the developers
on the [developers' mailing list](::mailto:#). on the [developers' mailing list](./::mailto:#.md).

16
src/ProductPlan/Feature-Format.md
View File

@ -1,7 +1,7 @@
<!-- markdownlint-disable-next-line first-line-h1 --> <!-- markdownlint-disable-next-line first-line-h1 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -9,18 +9,18 @@
##### Related Documents ##### Related Documents
- [SRS](SRS) > [Feature Set](Feature-Set) > Feature Specification Format - [SRS](./SRS.md) > [Feature Set](./Feature-Set.md) > Feature Specification Format
--- ---
**Process impact:** This reference page documents the format of feature **Process impact:** This reference page documents the format of feature
descriptions and gives tips on writing them. You can copy and paste the descriptions and gives tips on writing them. You can copy and paste the
feature specification template into your [Features](Features) feature specification template into your [Features](./Features.md)
document. This file itself should not be edited to hold specific document. This file itself should not be edited to hold specific
features. features.
_TODO: Copy and paste this feature specification template as many times _TODO: Copy and paste this feature specification template as many times
as needed in your [Features](Features) document._ as needed in your [Features](./Features.md) document._
--- ---
@ -32,9 +32,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risk | 2-Risk | 1-Risk | Safe Risk: ::Dangerous | 3-Risk | 2-Risk | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -79,6 +79,6 @@ Notes and Questions:
For more information on advice, see: For more information on advice, see:
- Words of wisdom on [feature sets](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/feature-set.html). - Words of wisdom on [feature sets](./https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/feature-set.html.md).
- Words of wisdom on [feature specifications](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/features.html). - Words of wisdom on [feature specifications](./https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/features.html.md).

106
src/ProductPlan/Feature-Set.md
View File

@ -10,10 +10,10 @@
##### Related Documents ##### Related Documents
- [SRS](SRS) > Feature Set - [SRS](./SRS.md) > Feature Set
- [Project proposal](Proposal) > [User needs](User-Needs) - [Project proposal](./Proposal.md) > [User needs](./User-Needs.md)
- [SRS](SRS) > [Use case suite](Use-Case-Suite) - [SRS](./SRS.md) > [Use case suite](./Use-Case-Suite.md)
- [Feature format](Feature-Format) - [Feature format](./Feature-Format.md)
- ::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
@ -30,11 +30,11 @@ _TODO: Before writing individual feature descriptions, list all the
features that you think you will need. Organize them so that missing features that you think you will need. Organize them so that missing
features appear as blanks on this page, and extra features will appear features appear as blanks on this page, and extra features will appear
to be extras that don't fit anywhere. See the to be extras that don't fit anywhere. See the
[feature format](Feature-Format#further-information) document for more [feature format](./Feature-Format#further-information.md) document for more
tips on specifying features and feature sets._ tips on specifying features and feature sets._
_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.md)
document and to the [use case suite](Use-Case-Suite). document and to the [use case suite](./Use-Case-Suite.md).
Use them for ideas and make sure that you cover all of them._ Use them for ideas and make sure that you cover all of them._
### Features by Release and Priority ### Features by Release and Priority
@ -47,76 +47,76 @@ consider estimated effort and risk._
- ::Release 1.0 - ::Release 1.0
- ::Essential - ::Essential
- ::[F-00](Features#f-00_site_configuration) Site configuration - ::[F-00](./Features#f-00_site_configuration.md) Site configuration
- ::[F-01](Features#f-01_user_regisration) User registration - ::[F-01](./Features#f-01_user_regisration.md) User registration
- ::[F-21](Features#f-21_feature_name) NAME OF FEATURE - ::[F-21](./Features#f-21_feature_name.md) NAME OF FEATURE
- ::[F-31](Features#f-31_feature_name) NAME OF FEATURE - ::[F-31](./Features#f-31_feature_name.md) NAME OF FEATURE
- ::Expected - ::Expected
- ::[F-02](Features#f-02_feature_name) NAME OF FEATURE - ::[F-02](./Features#f-02_feature_name.md) NAME OF FEATURE
- ::[F-03](Features#f-03_feature_name) NAME OF FEATURE - ::[F-03](./Features#f-03_feature_name.md) NAME OF FEATURE
- ::[F-20](Features#f-20_feature_name) NAME OF FEATURE - ::[F-20](./Features#f-20_feature_name.md) NAME OF FEATURE
- ::Release 1.1 - ::Release 1.1
- ::Expected - ::Expected
- ::[F-22](Features#f-22_feature_name) NAME OF FEATURE - ::[F-22](./Features#f-22_feature_name.md) NAME OF FEATURE
- ::[F-23](Features#f-23_feature_name) NAME OF FEATURE - ::[F-23](./Features#f-23_feature_name.md) NAME OF FEATURE
- ::[F-33](Features#f-33_feature_name) NAME OF FEATURE - ::[F-33](./Features#f-33_feature_name.md) NAME OF FEATURE
- ::Desired - ::Desired
- ::[F-10](Features#f-10_feature_name) NAME OF FEATURE - ::[F-10](./Features#f-10_feature_name.md) NAME OF FEATURE
- ::[F-11](Features#f-11_feature_name) NAME OF FEATURE - ::[F-11](./Features#f-11_feature_name.md) NAME OF FEATURE
- ::[F-12](Features#f-12_feature_name) NAME OF FEATURE - ::[F-12](./Features#f-12_feature_name.md) NAME OF FEATURE
- ::Later Releases - ::Later Releases
- ::Optional - ::Optional
- ::[F-30](Features#f-30_feature_name) NAME OF FEATURE - ::[F-30](./Features#f-30_feature_name.md) NAME OF FEATURE
- ::[F-32](Features#f-32_feature_name) NAME OF FEATURE - ::[F-32](./Features#f-32_feature_name.md) NAME OF FEATURE
### Features by Release and Risk ### Features by Release and Risk
- ::Release 1.0 - ::Release 1.0
- ::[F-00](Features#f-00_site_configuration) Safe : Site configuration - ::[F-00](./Features#f-00_site_configuration.md) Safe : Site configuration
- ::[F-01](Features#f-01_user_registration) Safe : User registration - ::[F-01](./Features#f-01_user_registration.md) Safe : User registration
- ::[F-21](Features#f-21_feature_name) Safe : NAME OF FEATURE - ::[F-21](./Features#f-21_feature_name.md) Safe : NAME OF FEATURE
- ::[F-31](Features#f-31_feature_name) 1-Risk : NAME OF FEATURE - ::[F-31](./Features#f-31_feature_name.md) 1-Risk : NAME OF FEATURE
- ::[F-02](Features#f-02_feature_name) 1-Risk : NAME OF FEATURE - ::[F-02](./Features#f-02_feature_name.md) 1-Risk : NAME OF FEATURE
- ::[F-03](Features#f-03_feature_name) 2-Risks : NAME OF FEATURE - ::[F-03](./Features#f-03_feature_name.md) 2-Risks : NAME OF FEATURE
- ::[F-20](Features#f-20_feature_name) 2-Risks : NAME OF FEATURE - ::[F-20](./Features#f-20_feature_name.md) 2-Risks : NAME OF FEATURE
- ::Total unique risk factors: 4 - ::Total unique risk factors: 4
- ::Release 1.1 - ::Release 1.1
- ::[F-22](Features#f-22_feature_name) Safe : NAME OF FEATURE - ::[F-22](./Features#f-22_feature_name.md) Safe : NAME OF FEATURE
- ::[F-23](Features#f-23_feature_name) Safe : NAME OF FEATURE - ::[F-23](./Features#f-23_feature_name.md) Safe : NAME OF FEATURE
- ::[F-33](Features#f-33_feature_name) Safe : NAME OF FEATURE - ::[F-33](./Features#f-33_feature_name.md) Safe : NAME OF FEATURE
- ::[F-10](Features#f-10_feature_name) 2-Risks : NAME OF FEATURE - ::[F-10](./Features#f-10_feature_name.md) 2-Risks : NAME OF FEATURE
- ::[F-11](Features#f-11_feature_name) 2-Risks : NAME OF FEATURE - ::[F-11](./Features#f-11_feature_name.md) 2-Risks : NAME OF FEATURE
- ::[F-12](Features#f-12_feature_name) 3-Risks : NAME OF FEATURE - ::[F-12](./Features#f-12_feature_name.md) 3-Risks : NAME OF FEATURE
- ::Total unique risk factors: 5 - ::Total unique risk factors: 5
- ::Later Releases - ::Later Releases
- ::[F-30](Features#f-30_feature_name) Safe : NAME OF FEATURE - ::[F-30](./Features#f-30_feature_name.md) Safe : NAME OF FEATURE
- ::[F-32](Features#f-32_feature_name) 2-Risks : NAME OF FEATURE - ::[F-32](./Features#f-32_feature_name.md) 2-Risks : NAME OF FEATURE
- ::Total unique risk factors: 2 - ::Total unique risk factors: 2
### Features by Functional Area ### Features by Functional Area
- ::FUNCTIONAL AREA ONE - ::FUNCTIONAL AREA ONE
- ::[F-00](Features#f-00_site_configuration) Site configuration - ::[F-00](./Features#f-00_site_configuration.md) Site configuration
- ::[F-01](Features#f-01_user_registration) User registration - ::[F-01](./Features#f-01_user_registration.md) User registration
- ::[F-02](Features#f-02_feature_name) NAME OF FEATURE - ::[F-02](./Features#f-02_feature_name.md) NAME OF FEATURE
- ::[F-03](Features#f-03_feature_name) NAME OF FEATURE - ::[F-03](./Features#f-03_feature_name.md) NAME OF FEATURE
- ::FUNCTIONAL AREA TWO - ::FUNCTIONAL AREA TWO
- ::[F-10](Features#f-10_feature_name) NAME OF FEATURE - ::[F-10](./Features#f-10_feature_name.md) NAME OF FEATURE
- ::[F-11](Features#f-11_feature_name) NAME OF FEATURE - ::[F-11](./Features#f-11_feature_name.md) NAME OF FEATURE
- ::[F-12](Features#f-12_feature_name) NAME OF FEATURE - ::[F-12](./Features#f-12_feature_name.md) NAME OF FEATURE
- ::[F-13](Features#f-13_feature_name) NAME OF FEATURE - ::[F-13](./Features#f-13_feature_name.md) NAME OF FEATURE
- ::FUNCTIONAL AREA THREE - ::FUNCTIONAL AREA THREE
- ::[F-20](Features#f-20_feature_name) NAME OF FEATURE - ::[F-20](./Features#f-20_feature_name.md) NAME OF FEATURE
- ::[F-21](Features#f-21_feature_name) NAME OF FEATURE - ::[F-21](./Features#f-21_feature_name.md) NAME OF FEATURE
- ::[F-22](Features#f-22_feature_name) NAME OF FEATURE - ::[F-22](./Features#f-22_feature_name.md) NAME OF FEATURE
- ::[F-23](Features#f-23_feature_name) NAME OF FEATURE - ::[F-23](./Features#f-23_feature_name.md) NAME OF FEATURE
- ::FUNCTIONAL AREA FOUR - ::FUNCTIONAL AREA FOUR
- ::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
- ::FUNCTIONAL AREA FIVE - ::FUNCTIONAL AREA FIVE
- ::TODO: need to write use cases here - ::TODO: need to write use cases here
- ::Other functional areas - ::Other functional areas
- ::[F-30](Features#f-30_feature_name) NAME OF FEATURE - ::[F-30](./Features#f-30_feature_name.md) NAME OF FEATURE
- ::[F-31](Features#f-31_feature_name) NAME OF FEATURE - ::[F-31](./Features#f-31_feature_name.md) NAME OF FEATURE
- ::[F-32](Features#f-32_feature_name) NAME OF FEATURE - ::[F-32](./Features#f-32_feature_name.md) NAME OF FEATURE
- ::[F-33](Features#f-33_feature_name) NAME OF FEATURE - ::[F-33](./Features#f-33_feature_name.md) NAME OF FEATURE

78
src/ProductPlan/Features.md
View File

@ -9,10 +9,10 @@
##### Related Documents ##### Related Documents
- [SRS](SRS) > [Feature Set](Feature-Set) > Features - [SRS](./SRS.md) > [Feature Set](./Feature-Set.md) > Features
- [Feature format](Feature-Format) - [Feature format](./Feature-Format.md)
- [Project proposal](Proposal) > [User needs](User-Needs) - [Project proposal](./Proposal.md) > [User needs](./User-Needs.md)
- [SRS](SRS) > [Use case suite](Use-Case-Suite) - [SRS](./SRS.md) > [Use case suite](./Use-Case-Suite.md)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -20,7 +20,7 @@
**Process impact:** This is a set of detailed feature descriptions. **Process impact:** This is a set of detailed feature descriptions.
_TODO: For each feature listed in the [feature set](Feature-Set), _TODO: For each feature listed in the [feature set](./Feature-Set.md),
give a detailed description of the feature here. Describe each feature give a detailed description of the feature here. Describe each feature
in enough detail that it could be implemented by any member of the in enough detail that it could be implemented by any member of the
development team (not only someone who already informally knows what to development team (not only someone who already informally knows what to
@ -48,9 +48,9 @@ Effort: ::Days
Risk: ::Safe Risk: ::Safe
Functional area(s): ::Administration Functional area(./s.md): ::Administration
Use case(s): ::[UC-00](Use-Cases#UC-00) [UC-11](Use-Cases#UC-11) Use case(./s.md): ::[UC-00](./Use-Cases#UC-00.md) [UC-11](./Use-Cases#UC-11.md)
Description: Description:
@ -75,20 +75,20 @@ Effort: ::Days
Risk: ::Safe Risk: ::Safe
Functional area(s): ::Administration Functional area(./s.md): ::Administration
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
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:
- ::username - ::username
- ::email address (twice to catch typos) - ::email address (./twice to catch typos.md)
- ::real name - ::real name
Precise Details: Precise Details:
- ::username must be unique (not equal to any other existing user name) - ::username must be unique (./not equal to any other existing user name.md)
- ::username must be of the form ~~~[a-zA-Z0-9]{2,16}~~~ and is not case sensitive - ::username must be of the form ~~~[a-zA-Z0-9]{2,16}~~~ and is not case sensitive
- ::email address must be of the form ~~~[-a-zA-Z0-9_.]{2,16}@[-a-zA-Z0-9_.]{6,64}~~~ - ::email address must be of the form ~~~[-a-zA-Z0-9_.]{2,16}@[-a-zA-Z0-9_.]{6,64}~~~
- ::both entries of the email address must match - ::both entries of the email address must match
@ -111,9 +111,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
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.
@ -138,9 +138,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -166,9 +166,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -194,9 +194,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -222,9 +222,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -250,9 +250,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -278,9 +278,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -306,9 +306,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -334,9 +334,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -362,9 +362,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -390,9 +390,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -418,9 +418,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -446,9 +446,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:
@ -474,9 +474,9 @@ Effort: ::Months | Weeks | Days | Hours
Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe Risk: ::Dangerous | 3-Risks | 2-Risks | 1-Risk | Safe
Functional area(s): ::WORD, WORD, WORD Functional area(./s.md): ::WORD, WORD, WORD
Use case(s): ::[UC-01](Use-Cases#UC-01) Use case(./s.md): ::[UC-01](./Use-Cases#UC-01.md)
Description: Description:

52
src/ProductPlan/Glossary-Standard-Terms.md
View File

@ -3,10 +3,10 @@
as they are used across projects. Individual projects should not need to as they are used across projects. Individual projects should not need to
edit this file. Writing out the definitions of terms and acronyms here edit this file. Writing out the definitions of terms and acronyms here
helps keep other documents more concise and easy to edit. Check the helps keep other documents more concise and easy to edit. Check the
[ReadySET glossary](https://web.archive.org/web/20200702035436/http://readyset.tigris.org/templates/glossary-std.html) for [ReadySET glossary](./https://web.archive.org/web/20200702035436/http://readyset.tigris.org/templates/glossary-std.html.md) for
updates. updates.
Jump to: [General](#general-terms) | [Computer science & technology](#computer-science-and-technology-terms) | [Process](#process-terms) | [Software development tools](#development-tool-terms) | [Requirements](#requirements-terms) | [Design](#design-terms) | [Design goals terms](#design-goals-terms) | [QA terms](#qa-terms) | [QA goals terms](#qa-goals-terms) | [Additional terms](#additional-standard-terms)| [Project terms](Glossary) Jump to: [General](./#general-terms.md) | [Computer science & technology](./#computer-science-and-technology-terms.md) | [Process](./#process-terms.md) | [Software development tools](./#development-tool-terms.md) | [Requirements](./#requirements-terms.md) | [Design](./#design-terms.md) | [Design goals terms](./#design-goals-terms.md) | [QA terms](./#qa-terms.md) | [QA goals terms](./#qa-goals-terms.md) | [Additional terms](./#additional-standard-terms.md)| [Project terms](./Glossary.md)
## General Terms ## General Terms
@ -72,23 +72,23 @@ sticky note.
## Computer Science and Technology Terms ## Computer Science and Technology Terms
### ::API (Application Programming Interface) ### ::API (./Application Programming Interface.md)
An API is a set of functions that one software component makes An API is a set of functions that one software component makes
available to other software components. That allows other programs available to other software components. That allows other programs
to "call" this program via direct function calls, or more indirect to "call" this program via direct function calls, or more indirect
communications such as [SOAP](#soap) messages. communications such as [SOAP](./#soap.md) messages.
### ::SOAP ### ::SOAP
SOAP (Simple Object Access Protocol) is the message format used by SOAP (./Simple Object Access Protocol.md) is the message format used by
standard web services. It entails sending an XML document to a standard web services. It entails sending an XML document to a
server in order to invoke an operation on the server-side. server in order to invoke an operation on the server-side.
[More information on SOAP](http://directory.google.com/Top/Computers/Programming/Internet/Web_Services/SOAP/?tc=1). [More information on SOAP](./http://directory.google.com/Top/Computers/Programming/Internet/Web_Services/SOAP/?tc=1.md).
## Process Terms ## Process Terms
### Change Control Board (CCB) ### Change Control Board (./CCB.md)
A group of people who review proposed changes to the project A group of people who review proposed changes to the project
requirements and/or source code to accept or reject changes in each requirements and/or source code to accept or reject changes in each
@ -138,7 +138,7 @@ than "10.1" or "11".
### Release Number ### Release Number
The term "release number" by itself refers to an The term "release number" by itself refers to an
[external release number](#external-release-number). Users normally are not aware [external release number](./#external-release-number.md). Users normally are not aware
of the existence of any internal release numbers. of the existence of any internal release numbers.
## Development Tool Terms ## Development Tool Terms
@ -167,7 +167,7 @@ of the existence of any internal release numbers.
::DEFINITION1 ::DEFINITION1
### Source Code Formatter (Pretty Printer) ### Source Code Formatter (./Pretty Printer.md)
::DEFINITION1 ::DEFINITION1
@ -189,7 +189,7 @@ many different ways as part of many different use cases.
### Use case ### Use case
The main part of a use case is a set of steps that give an example The main part of a use case is a set of steps that give an example
of how an [actor](#actor) can use the product to succeed at of how an [actor](./#actor.md) can use the product to succeed at
a goal. These steps are called the "Main success scenario", and they a goal. These steps are called the "Main success scenario", and they
include both user intentions and system responses. One use case may include both user intentions and system responses. One use case may
show how the actor uses several features to accomplish a goal. show how the actor uses several features to accomplish a goal.
@ -290,7 +290,7 @@ Prevent, e.g., hackers opening a command shell on our server.
### Abuse prevention ### Abuse prevention
Prevention of abuse (e.g., using our system to send spam). Prevention of abuse (./e.g., using our system to send spam.md).
### Auditability ### Auditability
@ -311,7 +311,7 @@ reasonable number of clicks and keystrokes.
### Safety ### Safety
Users are not likely to accidentally produce an undesired result Users are not likely to accidentally produce an undesired result
(e.g., delete data, or send a half-finished email). (./e.g., delete data, or send a half-finished email.md).
### Consistency and familiarity ### Consistency and familiarity
@ -322,18 +322,18 @@ this system.
### Bug ### Bug
*n.* **Deprecated** since 1991. See [defect](#defect). *n.* **Deprecated** since 1991. See [defect](./#defect.md).
### Error ### Error
*v.* A mistaken thought in the developer's mind. Often caused by *v.* A mistaken thought in the developer's mind. Often caused by
miscommunication or bad assumptions. Errors can create miscommunication or bad assumptions. Errors can create
[defects](#defect). E.g., a developer might erroneously think that [defects](./#defect.md). E.g., a developer might erroneously think that
the square root of -4 is -2. the square root of -4 is -2.
### Defect ### Defect
*n.* The result of the developer's [error](#error) embodied in the *n.* The result of the developer's [error](./#error.md) embodied in the
product source code, initial data, or documents. E.g., a square root product source code, initial data, or documents. E.g., a square root
function which allows negative numbers as arguments is defective. function which allows negative numbers as arguments is defective.
Defects can be removed by changing the source code, initial data, Defects can be removed by changing the source code, initial data,
@ -345,14 +345,14 @@ or document.
provided to defective code, it may cause an exception, or go into an provided to defective code, it may cause an exception, or go into an
infinite loop, or store an incorrect value in an internal variable. infinite loop, or store an incorrect value in an internal variable.
A fault is not normally visible to users, only the A fault is not normally visible to users, only the
[failure](#failure) is visible. [failure](./#failure.md) is visible.
### Failure ### Failure
*n.* The user-visible result of a [fault](#fault). E.g., an error *n.* The user-visible result of a [fault](./#fault.md). E.g., an error
message or an incorrect result. This is evidence that can be message or an incorrect result. This is evidence that can be
reported in a defect report. Developers use failure evidence during reported in a defect report. Developers use failure evidence during
debugging to eventually find and remove [defects](#defect). debugging to eventually find and remove [defects](./#defect.md).
## QA Goals Terms ## QA Goals Terms
@ -512,7 +512,7 @@ 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 Will it be easy for (./future.md) developers to understand how the system
works? works?
### Maintainability > Evolvability ### Maintainability > Evolvability
@ -524,16 +524,16 @@ Can the system easily be modified and extended over time?
Can the system easily be tested? Do the requirements precisely Can the system easily be tested? Do the requirements precisely
specify possible inputs and the desired results? Can the system be specify possible inputs and the desired results? Can the system be
tested in parts? When failures are observed, can they be traced back tested in parts? When failures are observed, can they be traced back
to defects in specific components (i.e., debugging)? Is testing to defects in specific components (./i.e., debugging.md)? Is testing
practical with the available testing tools? practical with the available testing tools?
## Additional Standard Terms ## Additional Standard Terms
For additional standard terms, see the following reference sites: For additional standard terms, see the following reference sites:
- [Dictionary.com](http://www.dictionary.com/) - [Dictionary.com](./http://www.dictionary.com/.md)
- [Whatis.com](http://www.whatis.com/) - [Whatis.com](./http://www.whatis.com/.md)
- [NIST Dictionary of Algorithms and Data Structures](http://www.nist.gov/dads/) - [NIST Dictionary of Algorithms and Data Structures](./http://www.nist.gov/dads/.md)
- [Free on-line dictionary of computing](http://foldoc.doc.ic.ac.uk/foldoc/index.html) - [Free on-line dictionary of computing](./http://foldoc.doc.ic.ac.uk/foldoc/index.html.md)
- [IBM's glossary of computing terms](http://www-3.ibm.com/ibm/terminology/goc/gocmain.htm) - [IBM's glossary of computing terms](./http://www-3.ibm.com/ibm/terminology/goc/gocmain.htm.md)
- [Jargon File](http://www.jargon.org/) - [Jargon File](./http://www.jargon.org/.md)

32
src/ProductPlan/Glossary.md
View File

@ -6,12 +6,12 @@ shared glossary helps prevent misunderstandings and makes it easier for
new team members to be productive. new team members to be productive.
<!-- markdownlint-disable link-fragments --> <!-- markdownlint-disable link-fragments -->
Jump to: [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) | Jump to: [A](./#a.md) | [B](./#b.md) | [C](./#c.md) | [D](./#d.md) | [E](./#e.md) | [F](./#f.md) |
[G](#g) | [H](#g) | [I](#i) | [J](#j) | [K](#k) | [L](#l) | [M](#m) | [G](./#g.md) | [H](./#g.md) | [I](./#i.md) | [J](./#j.md) | [K](./#k.md) | [L](./#l.md) | [M](./#m.md) |
[N](#n) | [O](#o) | [P](#p) | [Q](#q) | [R](#r) | [S](#s) | [T](#t) | [N](./#n.md) | [O](./#o.md) | [P](./#p.md) | [Q](./#q.md) | [R](./#r.md) | [S](./#s.md) | [T](./#t.md) |
[U](#u) | [V](#v) | [W](#w) | [X](#x) | [Y](#y) | [Z](#z) | [U](./#u.md) | [V](./#v.md) | [W](./#w.md) | [X](./#x.md) | [Y](./#y.md) | [Z](./#z.md) |
<!-- markdownlint-enable link-fragments --> <!-- markdownlint-enable link-fragments -->
[Standard terms](Glossary-Standard-Terms) [Standard terms](./Glossary-Standard-Terms.md)
## Project-specific Terms ## Project-specific Terms
@ -20,20 +20,20 @@ _TIPs:_
- _Define HTML anchors on your terms with id="TERMNAME" so that other - _Define HTML anchors on your terms with id="TERMNAME" so that other
documents can link to the definition of specific terms._ documents can link to the definition of specific terms._
- _If there is any question about the meaning of a term, note it here. - _If there is any question about the meaning of a term, note it here.
If someone (e.g., the customer) gave you a definition to use, note If someone (./e.g., the customer.md) gave you a definition to use, note
that here too. If something is best defined by using a hyperlink to that here too. If something is best defined by using a hyperlink to
another document or website, include a hyperlink in the definition._ another document or website, include a hyperlink in the definition._
- _If a term was used in the past, but is no longer going to be used, - _If a term was used in the past, but is no longer going to be used,
you should keep it in the list, mark it as "deprecated", and link to you should keep it in the list, mark it as "deprecated", and link to
the term or terms that replace it. E.g., deprecated standard term the term or terms that replace it. E.g., deprecated standard term
[bug](glossary-std.html#bug)._ [bug](./glossary-std.html#bug.md)._
- _Define only project-specific terms, or ones that a new team member - _Define only project-specific terms, or ones that a new team member
would not know. Don't define standard textbook terms that can be would not know. Don't define standard textbook terms that can be
easily found elsewhere._ easily found elsewhere._
- _This glossary can serve as simple domain model or data dictionary. - _This glossary can serve as simple domain model or data dictionary.
You can define important data objects by describing their meaning You can define important data objects by describing their meaning
and key attributes. For example, see [student](#student) and and key attributes. For example, see [student](./#student.md) and
[GPA](#gpa)._ [GPA](./#gpa.md)._
### A ### A
@ -43,7 +43,7 @@ _TIPs:_
#### ::Class standing #### ::Class standing
- ::Computed attribute of [student](#student) based on number of - ::Computed attribute of [student](./#student.md) based on number of
academic units completed. Used to determine priority in academic units completed. Used to determine priority in
course enrollment. course enrollment.
- ::Real-world meaning of values: - ::Real-world meaning of values:
@ -61,8 +61,8 @@ _TIPs:_
#### ::GEF #### ::GEF
::_n._ The [Graph Editing Framework](http://gef.tigris.org/). An open ::_n._ The [Graph Editing Framework](./http://gef.tigris.org/.md). An open
source library for editing diagrams (boxes and arrows). source library for editing diagrams (./boxes and arrows.md).
#### ::GPA #### ::GPA
@ -77,19 +77,19 @@ academic probation.
#### ::ICS #### ::ICS
::_n._ Acronym for the [School of Information and Computer ::_n._ Acronym for the [School of Information and Computer
Science](http://www.ics.uci.edu/) at [UC Irvine](http://www.uci.edu/). Science](./http://www.ics.uci.edu/.md) at [UC Irvine](./http://www.uci.edu/.md).
### S ### S
#### ::Student #### ::Student
::_n._ A person who attends a school to earn a degree. Persistent ::_n._ A person who attends a school to earn a degree. Persistent
attributes include: student_id_number (primary key), GPA, major, attributes include: student_id_number (./primary key.md), GPA, major,
and years_at_school. and years_at_school.
#### ::Senior #### ::Senior
::_n._ A senior is special type of [undergraduate](#undergraduate) who ::_n._ A senior is special type of [undergraduate](./#undergraduate.md) who
has a certain number of course credits on his or her transcript. has a certain number of course credits on his or her transcript.
Years_at_school does not determine senior standing. TODO: how many Years_at_school does not determine senior standing. TODO: how many
credits needed? credits needed?
@ -113,4 +113,4 @@ credits needed?
#### ::Undergraduate #### ::Undergraduate
::A type of [student](#student). _TODO: add more detail._ ::A type of [student](./#student.md). _TODO: add more detail._

32
src/ProductPlan/Home.md
View File

@ -20,11 +20,11 @@ _TODO: Answer these questions in your own words by filling in each_
#### What development methodology is being used? #### What development methodology is being used?
::See our [software development methodology](SDM) document. ::See our [software development methodology](./SDM.md) document.
#### Where should a new team member start? #### Where should a new team member start?
::For more information, see the [project proposal](Proposal). ::For more information, see the [project proposal](./Proposal.md).
### Status ### Status
@ -34,7 +34,7 @@ is written in the status reports, not here._
::We have completed our second beta release and are currently working on ::We have completed our second beta release and are currently working on
adding more of the functionality described in our product adding more of the functionality described in our product
[specification](srs) and fixing defects. [specification](./srs.md) and fixing defects.
::The next major milestone is a third beta release with nearly complete ::The next major milestone is a third beta release with nearly complete
functionality and a wider set of testers. functionality and a wider set of testers.
@ -43,19 +43,19 @@ functionality and a wider set of testers.
| By Activity | Documents | | By Activity | Documents |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Inception: | [Home](Home), [Project Proposal](Proposal), [Target Audience and Benefits](Target-and-Benefits), [Statement of User Needs](User-Needs) | | Inception: | [Home](./Home.md), [Project Proposal](./Proposal.md), [Target Audience and Benefits](./Target-and-Benefits.md), [Statement of User Needs](./User-Needs.md) |
| Reference: | [Glossary](Glossary), [Software Development Methodology](SDM), [Document Cross Reference](Document-Cross-Ref), [All-in-one project summary](Summary) | | Reference: | [Glossary](./Glossary.md), [Software Development Methodology](./SDM.md), [Document Cross Reference](./Document-Cross-Ref.md), [All-in-one project summary](./Summary.md) |
| Elaboration: | [Project Plan](Project-Plan), [Software Requirements Specification](SRS), [Feature Set](Feature-Set), [Use Case Suite](Use-Case-Suite), [Design](Design), [QA Plan](QA-Plan), [Test Suite](Test-Suite) | | Elaboration: | [Project Plan](./Project-Plan.md), [Software Requirements Specification](./SRS.md), [Feature Set](./Feature-Set.md), [Use Case Suite](./Use-Case-Suite.md), [Design](./Design.md), [QA Plan](./QA-Plan.md), [Test Suite](./Test-Suite.md) |
| Construction: | [Review Meeting Notes](Review-Meeting-Notes), [Implementation Notes](Implementation-Notes), [User Guide](User-Guide), [FAQ / Troubleshooting Guide](FAQ) | | Construction: | [Review Meeting Notes](./Review-Meeting-Notes.md), [Implementation Notes](./Implementation-Notes.md), [User Guide](./User-Guide.md), [FAQ / Troubleshooting Guide](./FAQ.md) |
| Transition: | [Install / Quick Start](Installation-Guide), [Demo Script](Demo-Script), [Release notes](Release-Notes), [Release checklist](Release-Checklist), [Post Mortem](Post-Mortem) | | Transition: | [Install / Quick Start](./Installation-Guide.md), [Demo Script](./Demo-Script.md), [Release notes](./Release-Notes.md), [Release checklist](./Release-Checklist.md), [Post Mortem](./Post-Mortem.md) |
| Continuous: | [Status Report](Status-Report) | | Continuous: | [Status Report](./Status-Report.md) |
| By Audience | Documents | | By Audience | Documents |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| For Everyone: | [Home](Home), [Project Proposal](Proposal), [Target Audience and Benefits](Target-and-Benefits), [Statement of User Needs](User-Needs), [Software Requirements Specification](SRS), [Project Plan](Project-plan), [Release Checklist](Release-Checklist), [Glossary](Glossary) | | For Everyone: | [Home](./Home.md), [Project Proposal](./Proposal.md), [Target Audience and Benefits](./Target-and-Benefits.md), [Statement of User Needs](./User-Needs.md), [Software Requirements Specification](./SRS.md), [Project Plan](./Project-plan.md), [Release Checklist](./Release-Checklist.md), [Glossary](./Glossary.md) |
| For Management: | [Project Resource Needs](Resource-Needs), [Status Report](Status-Report) | | For Management: | [Project Resource Needs](./Resource-Needs.md), [Status Report](./Status-Report.md) |
| For Developers: | [Design](Design), [Review Meeting Notes](Review-Meeting-Notes), [Software Development Methodology](SDM) | | For Developers: | [Design](./Design.md), [Review Meeting Notes](./Review-Meeting-Notes.md), [Software Development Methodology](./SDM.md) |
| For QA: | [QA Plan](QA-Plan) | | For QA: | [QA Plan](./QA-Plan.md) |
| For End Users: | [Install / Quick start](Installation-Guide), [User Guide](User-Guide), [Release Notes](Release-Notes) | | For End Users: | [Install / Quick start](./Installation-Guide.md), [User Guide](./User-Guide.md), [Release Notes](./Release-Notes.md) |
| For Support and Ops: | [Implementation Notes](Implementation-Notes), [FAQ / Troubleshooting Guide](FAQ) | | For Support and Ops: | [Implementation Notes](./Implementation-Notes.md), [FAQ / Troubleshooting Guide](./FAQ.md) |
| For Sales/Legal: | [Demo Script](Demo-Script), [Legal Issues](Legal) | | For Sales/Legal: | [Demo Script](./Demo-Script.md), [Legal Issues](./Legal.md) |

26
src/ProductPlan/Implementation-Notes.md
View File

@ -2,7 +2,7 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -10,10 +10,10 @@
##### Related Documents ##### Related Documents
- [Software Requirements Specification](SRS) - [Software Requirements Specification](./SRS.md)
- [Release notes](Release-Notes) - [Release notes](./Release-Notes.md)
- [FAQ](FAQ) - [FAQ](./FAQ.md)
- [Glossary](Glossary) - [Glossary](./Glossary.md)
--- ---
@ -47,7 +47,7 @@ specific technology platforms._
- ::Reusable class framework || - ::Reusable class framework ||
- ::Browser Plug-in - ::Browser Plug-in
#### Programming Language(s) #### Programming Language(./s.md)
- ::Java || - ::Java ||
- ::Perl, Unix shell scripts - ::Perl, Unix shell scripts
@ -140,11 +140,11 @@ engineers when the system is being run in an ASP production environment._
#### Install #### Install
::See the [installation guide](Installation-Guide) ::See the [installation guide](./Installation-Guide.md)
#### Upgrade #### Upgrade
::See the [installation guide](Installation-Guide) ::See the [installation guide](./Installation-Guide.md)
#### Start Server #### Start Server
@ -205,11 +205,11 @@ Do these implementation notes provide enough information for operations engineer
- ::Yes, these notes have been reviewed by the operations team and - ::Yes, these notes have been reviewed by the operations team and
requested changes have been incorporated. requested changes have been incorporated.
- ::No, these notes only summarize parts of a larger - ::No, these notes only summarize parts of a larger
[operations manual](LINK-TO-OPERATIONS-MANUAL). [operations manual](./LINK-TO-OPERATIONS-MANUAL.md).
- ::No, a member of the development team is available on-call whenever - ::No, a member of the development team is available on-call whenever
the operations team may need help. This is listed in the the operations team may need help. This is listed in the
[Resource Needs](Resource-Needs) document and in the [Resource Needs](./Resource-Needs.md) document and in the
[on-call schedule](LINK-TO-ON-CALL-SCHEDULE). [on-call schedule](./LINK-TO-ON-CALL-SCHEDULE.md).
Have these implementation notes been communicated to the operations and development teams and other stakeholders? Have these implementation notes been communicated to the operations and development teams and other stakeholders?
@ -217,5 +217,5 @@ Have these implementation notes been communicated to the operations and developm
- ::Yes, it has been posted to the project website. - ::Yes, it has been posted to the project website.
- ::No, some developers or operations engineers are not aware of - ::No, some developers or operations engineers are not aware of
this document. This is a risk that is noted in the this document. This is a risk that is noted in the
[Risk Management](Project-Plan#risk-management) section of the [Risk Management](./Project-Plan#risk-management.md) section of the
[Project Plan](Project-Plan). [Project Plan](./Project-Plan.md).

14
src/ProductPlan/Installation-Guide.md
View File

@ -19,7 +19,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 [website](./::http://www.COMPANY.com/products/PRODUCT-NAME/.md) or
email us at <::support@COMPANY.com> email us at <::support@COMPANY.com>
--- ---
@ -31,7 +31,7 @@ PRODUCT-NAME.
### Minimal System Requirements ### Minimal System Requirements
::System requirements are described in the [release notes](Release-Notes). ::System requirements are described in the [release notes](./Release-Notes.md).
### Installation ### Installation
@ -47,10 +47,10 @@ needed development and bugging tools, e.g., Ant and JUnit._
::Before you can install this product, you must install the following ::Before you can install this product, you must install the following
packages: packages:
- ::[Java SDK](http://java.sun.com/) - ::[Java SDK](./http://java.sun.com/.md)
- ::[Apache Tomcat](http://jakarta.apache.org/) - ::[Apache Tomcat](./http://jakarta.apache.org/.md)
- ::[MySQL database](http://mysql.com/) - ::[MySQL database](./http://mysql.com/.md)
- ::[OTHER PACKAGES](http://) - ::[OTHER PACKAGES](./http://.md)
#### How do I install PRODUCT-NAME? #### How do I install PRODUCT-NAME?
@ -72,7 +72,7 @@ packages:
#### What if I encounter problems? #### What if I encounter problems?
::Please see the troubleshooting section in the [FAQ](FAQ). ::Please see the troubleshooting section in the [FAQ](./FAQ.md).
### Getting Started ### Getting Started

6
src/ProductPlan/Interview-Checklist.md
View File

@ -2,8 +2,8 @@
##### Related Documents ##### Related Documents
- [User Needs](User-Needs) - [User Needs](./User-Needs.md)
- [Interview Notes](interview-notes.html) - [Interview Notes](./interview-notes.html.md)
--- ---
@ -50,7 +50,7 @@ interviews.
1. Be prompt, courteous, and business-like 1. Be prompt, courteous, and business-like
2. Introduce yourself and explain why you are there 2. Introduce yourself and explain why you are there
3. Make sure that you are interviewing the person you think you are. 3. Make sure that you are interviewing the person you think you are.
Get their contact information (e.g., email address) if you don't Get their contact information (./e.g., email address.md) if you don't
already have it. already have it.
4. Ask permission to take notes. Don't record or video tape. 4. Ask permission to take notes. Don't record or video tape.
5. Confirm the amount of time you and the interviewee have for 5. Confirm the amount of time you and the interviewee have for

20
src/ProductPlan/Interview-Notes.md
View File

@ -2,13 +2,13 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Interviewer(s) ##### Interviewer(./s.md)
::PERSON-NAME ::PERSON-NAME
##### Interviewee(s) ##### Interviewee(./s.md)
::PERSON-NAME ::PERSON-NAME
@ -22,9 +22,9 @@
##### Related Documents ##### Related Documents
- [Project proposal](Proposal) > [Target audience and benefits](Target-and-Benefits) - [Project proposal](./Proposal.md) > [Target audience and benefits](./Target-and-Benefits.md)
- [Interview checklist](Interview-Checklist) - [Interview checklist](./Interview-Checklist.md)
- [Glossary](Glossary) - [Glossary](./Glossary.md)
--- ---
@ -35,8 +35,8 @@ of user-needs.md._
**Process impact:** Planning questions for interviews with stakeholders **Process impact:** Planning questions for interviews with stakeholders
is key to effective requirements gathering. Good requirements are needed is key to effective requirements gathering. Good requirements are needed
to build the right system. These notes should be kept as part of the to build the right system. These notes should be kept as part of the
documentation on [user needs](User-Needs) are referred to when the documentation on [user needs](./User-Needs.md) are referred to when the
[software requirements specification](SRS) is written or updated. [software requirements specification](./SRS.md) is written or updated.
### Interview Questions and Answers ### Interview Questions and Answers
@ -84,8 +84,8 @@ Note these new questions and what you must do to find the answer._
- ::Can we do X? - ::Can we do X?
- ::Do we support Y? - ::Do we support Y?
- ::Action item: research topic Z - ::Action item: research topic Z
- ::Action item: Send follow-up email as per [post-interview checklist](Interview-Checklist#post-interview-checklist) - ::Action item: Send follow-up email as per [post-interview checklist](./Interview-Checklist#post-interview-checklist.md)
- ::Action item: prepare for next interview with PERSON(S) on DATE - ::Action item: prepare for next interview with PERSON(./S.md) on DATE
### Other Interview Notes ### Other Interview Notes

18
src/ProductPlan/Legal.md
View File

@ -2,7 +2,7 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -11,9 +11,9 @@
##### Release Audience ##### Release Audience
- ::General availability release || - ::General availability release ||
- ::Customer-specific release: CUSTOMER(S) || - ::Customer-specific release: CUSTOMER(./S.md) ||
- ::Developer release (Internal usage only) || - ::Developer release (./Internal usage only.md) ||
- ::Early access release (Controlled external access) - ::Early access release (./Controlled external access.md)
##### Intended Product License ##### Intended Product License
@ -21,9 +21,9 @@
##### Related Documents ##### Related Documents
- [Project proposal](Proposal) > [Target audience and benefits](Target-and-Benefits) - [Project proposal](./Proposal.md) > [Target audience and benefits](./Target-and-Benefits.md)
- [Project Plan](Project-Plan) > [Resource needs](Resource-Needs) - [Project Plan](./Project-Plan.md) > [Resource needs](./Resource-Needs.md)
- [Glossary](Glossary) - [Glossary](./Glossary.md)
--- ---
@ -39,7 +39,7 @@ professional counsel for review as needed._
| Component | Owner | License | Status | Comments | | Component | Owner | License | Status | Comments |
| -------------------------- | ------------ | -------------------- | --------------------------------------------- | -------------------------------------------------------------- | | -------------------------- | ------------ | -------------------- | --------------------------------------------- | -------------------------------------------------------------- |
| ::Product name | ::Us | ::Trademark | ::Registration pending | ::We must use "(TM)", not "(R)" | | ::Product name | ::Us | ::Trademark | ::Registration pending | ::We must use "(./TM.md)", not "(./R.md)" |
| ::Database | ::VENDOR | ::Commercial license | ::In compliance, paid normal fee | ::Limits us to 2 CPUs/server | | ::Database | ::VENDOR | ::Commercial license | ::In compliance, paid normal fee | ::Limits us to 2 CPUs/server |
| ::Encryption library | ::VENDOR | ::Commercial license | ::In compliance, signed partnership agreement | | | ::Encryption library | ::VENDOR | ::Commercial license | ::In compliance, signed partnership agreement | |
| ::Clip-art graphics | ::None | ::Public Domain | ::In compliance | | | ::Clip-art graphics | ::None | ::Public Domain | ::In compliance | |
@ -119,7 +119,7 @@ as needed._
::No. No action needed. ::No. No action needed.
#### Does the product satisfy corporate policies (e.g., on privacy and security)? #### Does the product satisfy corporate policies (./e.g., on privacy and security.md)?
::Yes. Describe how each policy is satisfied.. ::Yes. Describe how each policy is satisfied..

10
src/ProductPlan/License.md
View File

@ -4,7 +4,7 @@ which you may use the ReadySET templates.
### Copyright and License ### Copyright and License
Copyright (C) 2003-2004 Jason Robbins. All rights reserved. Copyright (./C.md) 2003-2004 Jason Robbins. All rights reserved.
Redistribution and use in source and binary forms, with or without Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions modification, are permitted provided that the following conditions
@ -21,7 +21,7 @@ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING STRICT LIABILITY, OR TORT (./INCLUDING NEGLIGENCE OR OTHERWISE.md) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE. POSSIBILITY OF SUCH DAMAGE.
@ -49,7 +49,7 @@ If you use the templates and fill in details about a given product,
go ahead. If you are thinking of making a product that includes the go ahead. If you are thinking of making a product that includes the
templates for use _as templates_, you must retain this file and the templates for use _as templates_, you must retain this file and the
copyright statement in a visible footnote. An enhanced commercial copyright statement in a visible footnote. An enhanced commercial
version of these templates, [ReadySETPro](http://www.readysetpro.com/), version of these templates, [ReadySETPro](./http://www.readysetpro.com/.md),
is already in development is already in development
#### Can I combine these templates with other templates or documents? #### Can I combine these templates with other templates or documents?
@ -63,11 +63,11 @@ 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](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/). [ReadySET home page](./https://web.archive.org/web/20200701142616/http://readyset.tigris.org/.md).
#### 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?
There is no catch. However, the scope of ReadySET is limited to only There is no catch. However, the scope of ReadySET is limited to only
most common needs of development projects. It is easy to get started most common needs of development projects. It is easy to get started
with ReadySET, but [ReadySET Pro](http://www.readysetpro.com/) holds with ReadySET, but [ReadySET Pro](./http://www.readysetpro.com/.md) holds
much more value for corporate users. much more value for corporate users.

40
src/ProductPlan/Project-Plan.md
View File

@ -2,7 +2,7 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Project Time-frame ##### Project Time-frame
@ -10,13 +10,13 @@
##### Attached worksheets ##### Attached worksheets
- Plan > [Resource Needs](Resource-Needs) - Plan > [Resource Needs](./Resource-Needs.md)
##### Related Documents ##### Related Documents
- [Project Proposal](Proposal) > [Target audience and benefits](Target-and-Benefits) - [Project Proposal](./Proposal.md) > [Target audience and benefits](./Target-and-Benefits.md)
- [Software development methodology](SDM) - [Software development methodology](./SDM.md)
- [Glossary](Glossary) - [Glossary](./Glossary.md)
--- ---
@ -32,7 +32,7 @@ needed. Use the worksheet to help identify and scope resource needs._
#### What are the business problem, scope, and goal of this project? #### What are the business problem, scope, and goal of this project?
For a summary of this project, see the [Project proposal](Proposal). For a summary of this project, see the [Project proposal](./Proposal.md).
#### Who will sponsor, manage, and lead the project? #### Who will sponsor, manage, and lead the project?
@ -66,7 +66,7 @@ For a summary of this project, see the [Project proposal](Proposal).
::THREE TO FIVE SENTENCES OR BULLETS HERE. COVER GENERAL APPROACH, IMPORTANT ASSUMPTIONS, KEY PRACTICES, AND PROJECT COORDINATION CONTROLS. ::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). For more information see the [Software Development Methodology](./SDM.md).
#### How will the project team be organized? #### How will the project team be organized?
@ -87,16 +87,16 @@ For more information see the [Software Development Methodology](SDM).
#### How will changes be controlled? #### How will changes be controlled?
- ::Requests for requirements changes will be tracked in the issue tracker - ::Requests for requirements changes will be tracked in the issue tracker
- ::The change control board ([CCB](Glossary#ccb)) will review requested changes and authorize work on them as appropriate - ::The change control board (./[CCB](Glossary#ccb.md)) will review requested changes and authorize work on them as appropriate
- ::After the [feature complete](Glossary#featurecomplete) milestone, no new features will be added to this release. - ::After the [feature complete](./Glossary#featurecomplete.md) milestone, no new features will be added to this release.
- ::After the [code complete](Glossary#codecomplete) milestone, no entirely new product source code will be added to this release. - ::After the [code complete](./Glossary#codecomplete.md) milestone, no entirely new product source code will be added to this release.
- ::All source code commit log messages must refer to a specific issue ID, after the feature complete milestone. - ::All source code commit log messages must refer to a specific issue ID, after the feature complete milestone.
#### How will this plan be updated? #### How will this plan be updated?
::This project plan will be updated as needed throughout the project. ::This project plan will be updated as needed throughout the project.
It will be placed under version control and instructions for It will be placed under version control and instructions for
accessing it will be on the [project website](Home). Any accessing it will be on the [project website](./Home.md). Any
change to the plan will cause an automatic notification to be sent change to the plan will cause an automatic notification to be sent
to a project mailing list. to a project mailing list.
@ -123,7 +123,7 @@ finished. Don't worry about renumbering if you delete a step._
| 2.3. | ::Requirements validation | 10h | | 2.3. | ::Requirements validation | 10h |
| 3. | ::Elaboration | | | 3. | ::Elaboration | |
| 3.1. | ::High-level design | 5h | | 3.1. | ::High-level design | 5h |
| 3.2. | ::Low-level design (break down by component) | | | 3.2. | ::Low-level design (./break down by component.md) | |
| 3.2.A. | ::Object design | 10h | | 3.2.A. | ::Object design | 10h |
| 3.2.B. | ::User interface design | 10h | | 3.2.B. | ::User interface design | 10h |
| 3.2.C. | ::Database design | 3h | | 3.2.C. | ::Database design | 3h |
@ -134,12 +134,12 @@ finished. Don't worry about renumbering if you delete a step._
| 4.1.A.2. | ::Implement COMPONENT-NAME 2 | 25h | | 4.1.A.2. | ::Implement COMPONENT-NAME 2 | 25h |
| 4.1.A.3. | ::Implement COMPONENT-NAME 3 | 25h | | 4.1.A.3. | ::Implement COMPONENT-NAME 3 | 25h |
| 4.1.A.4. | ::Implement COMPONENT-NAME 4 | 25h | | 4.1.A.4. | ::Implement COMPONENT-NAME 4 | 25h |
| 4.1.A.5. | ::Integrate Components (mostly done during implementation) | 5h | | 4.1.A.5. | ::Integrate Components (./mostly done during implementation.md) | 5h |
| 4.1.B. | ::Technical documentation (break down by component) | 10h | | 4.1.B. | ::Technical documentation (./break down by component.md) | 10h |
| 4.1.C. | ::User documentation (break down by component) | 10h | | 4.1.C. | ::User documentation (./break down by component.md) | 10h |
| 4.1.D. | ::Testing | | | 4.1.D. | ::Testing | |
| 4.1.D.1. | ::Test planning | 10h | | 4.1.D.1. | ::Test planning | 10h |
| 4.1.D.2. | ::Test code implementation (break down by component) | 30h | | 4.1.D.2. | ::Test code implementation (./break down by component.md) | 30h |
| 4.1.D.3. | ::Test execution | 10h | | 4.1.D.3. | ::Test execution | 10h |
| 4.2. | ::Implementation review and evaluation | 15h | | 4.2. | ::Implementation review and evaluation | 15h |
| 5. | ::Transition | | | 5. | ::Transition | |
@ -170,7 +170,7 @@ engineering time that the team will spend on that task that week. Total
your hours across and down._ your hours across and down._
_TIP: These hours should total to the same as the total of the hours _TIP: These hours should total to the same as the total of the hours
listed in your [resource needs](Resource-Needs) document. And, the listed in your [resource needs](./Resource-Needs.md) document. And, the
hours for each type of effort resources needed should correspond to the hours for each type of effort resources needed should correspond to the
sum for each type of task._ sum for each type of task._
@ -193,16 +193,16 @@ sum for each type of task._
_TODO: List and rank the major risks of this project, and what you plan _TODO: List and rank the major risks of this project, and what you plan
to do to mitigate each risk. If you don't plan to do anything to to do to mitigate each risk. If you don't plan to do anything to
mitigate the risk, state that. Use the risk list below, or the [risks mitigate the risk, state that. Use the risk list below, or the [risks
worksheet](Risks)._ worksheet](./Risks.md)._
Please see the [risks worksheet](Risks). Please see the [risks worksheet](./Risks.md).
#### The main risks of this project are #### The main risks of this project are
1. ::There is a potential conflict between the goals of a high-quality appearance and one that is completely customizable. We can only succeed if players find the web site appealing, and game vendors can customize it with no more effort than would be needed to build a static website. We already have a design in mind that will address this risk and we will review it with a web site designer who worked for a game vendor site. 1. ::There is a potential conflict between the goals of a high-quality appearance and one that is completely customizable. We can only succeed if players find the web site appealing, and game vendors can customize it with no more effort than would be needed to build a static website. We already have a design in mind that will address this risk and we will review it with a web site designer who worked for a game vendor site.
2. ::There are significant technical difficulties in building a web site and web application. This will be a risk because one person on our team has much experience with the relevant tools and technologies. Although the others will learn, we will certainly make some mistakes and sub-optimal choices. We will address this risk by scoping the project such that we have enough time to train and to review the design and implementation. 2. ::There are significant technical difficulties in building a web site and web application. This will be a risk because one person on our team has much experience with the relevant tools and technologies. Although the others will learn, we will certainly make some mistakes and sub-optimal choices. We will address this risk by scoping the project such that we have enough time to train and to review the design and implementation.
3. ::The schedule for this project is very short. We will manage this by planning a conservatively scoped functional core and series of functional enhancements that can be individually slipped to later releases if needed. 3. ::The schedule for this project is very short. We will manage this by planning a conservatively scoped functional core and series of functional enhancements that can be individually slipped to later releases if needed.
4. ::The performance of the system will be significantly impacted by the decisions made during the [database design task](#3.2.C). None of our current team members has experience with database optimization. To address this, we will arrange a review meeting with an experienced DBA or hire a consultant from the database vendor. 4. ::The performance of the system will be significantly impacted by the decisions made during the [database design task](./#3.2.C.md). None of our current team members has experience with database optimization. To address this, we will arrange a review meeting with an experienced DBA or hire a consultant from the database vendor.
5. ::We could be underestimating known tasks. 5. ::We could be underestimating known tasks.
HOW TO AVOID/MITIGATE? HOW TO AVOID/MITIGATE?
6. ::We could be underestimating the impact of unknown tasks. 6. ::We could be underestimating the impact of unknown tasks.

38
src/ProductPlan/Proposal.md
View File

@ -2,7 +2,7 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Project Time-frame ##### Project Time-frame
@ -14,12 +14,12 @@
##### Attached Worksheets ##### Attached Worksheets
Project Proposal > [Target audience and benefits](Target-and-Benefits) Project Proposal > [Target audience and benefits](./Target-and-Benefits.md)
##### Related Documents ##### Related Documents
- [Project plan](Project-Plan) > [Resource needs](Resource-Needs) - [Project plan](./Project-Plan.md) > [Resource needs](./Resource-Needs.md)
- [Glossary](Glossary) - [Glossary](./Glossary.md)
--- ---
@ -33,7 +33,7 @@ project.
_TODO: Replace the example text below with text that describes your _TODO: Replace the example text below with text that describes your
project. What are the needs or problems that you are trying to address? project. What are the needs or problems that you are trying to address?
Why do these needs (still) exist? Why are these problems worth solving? Why do these needs (./still.md) exist? Why are these problems worth solving?
Who is the customer? Write 2-4 paragraphs._ Who is the customer? Write 2-4 paragraphs._
#### What is the setting and history behind this project? #### What is the setting and history behind this project?
@ -65,8 +65,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](#tbd) - ::[Example of current manually maintained clan website](./#tbd.md)
- ::[Link to existing competitor](#tbd) - ::[Link to existing competitor](./#tbd.md)
#### Why is this problem worth solving or worth solving better? #### Why is this problem worth solving or worth solving better?
@ -101,9 +101,9 @@ those advantages.
::The following pages provide additional background and motivation: ::The following pages provide additional background and motivation:
- ::[Magazine article on this topic](#tbd) - ::[Magazine article on this topic](./#tbd.md)
- ::[Industry analysis's report on massive-multi-player game market](#tbd) - ::[Industry analysis's report on massive-multi-player game market](./#tbd.md)
- ::[Quotes from game players](#tbd) - ::[Quotes from game players](./#tbd.md)
### Goal ### Goal
@ -130,11 +130,11 @@ allows players to quickly find, evaluate, and join clans.
#### Where are other documents that further explain the goal of this project? #### Where are other documents that further explain the goal of this project?
- ::[Mock-up](LINK-TO-MOCKUP) - ::[Mock-up](./LINK-TO-MOCKUP.md)
- ::[Early user stories](LINK-TO-EARLY-STORIES) - ::[Early user stories](./LINK-TO-EARLY-STORIES.md)
- ::[Quotes from potential customers](LINK-TO-QUOTES) - ::[Quotes from potential customers](./LINK-TO-QUOTES.md)
- ::[Comparison to existing competitors](LINK-TO-COMPARISON) - ::[Comparison to existing competitors](./LINK-TO-COMPARISON.md)
- ::[Draft feature list](LINK-TO-DRAFT-FEATURES) - ::[Draft feature list](./LINK-TO-DRAFT-FEATURES.md)
### Scope ### Scope
@ -148,7 +148,7 @@ bullet list, in/out list, and/or UML context diagram._
::We want to focus on the web application itself, and the features of that ::We want to focus on the web application itself, and the features of that
application that help build a good gaming community. application that help build a good gaming community.
::See the [context diagram](LINK-TO-CONTEXT-DIAGRAM). ::See the [context diagram](./LINK-TO-CONTEXT-DIAGRAM.md).
- ::Work with common servers and browsers that we are already - ::Work with common servers and browsers that we are already
familiar with. familiar with.
@ -161,7 +161,7 @@ application that help build a good gaming community.
| In Scope | Out of Scope | | In Scope | Out of Scope |
| -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ::Building a web application for use with standard web servers and application servers | ::Building a new web server or application server | | ::Building a web application for use with standard web servers and application servers | ::Building a new web server or application server |
| ::Working the most popular browsers (IE6, NN7/Mozilla) | ::Working with uncommon or outdated browsers | | ::Working the most popular browsers (./IE6, NN7/Mozilla.md) | ::Working with uncommon or outdated browsers |
| ::Security in the form of user accounts, passwords, and permissions | ::Special security against hackers. Finding or patching security holes in existing software components. | | ::Security in the form of user accounts, passwords, and permissions | ::Special security against hackers. Finding or patching security holes in existing software components. |
| ::One simple sample look-and-feel and instructions for customization | ::Our own high-quality look-and-feel. A library of look-and-feel options. | | ::One simple sample look-and-feel and instructions for customization | ::Our own high-quality look-and-feel. A library of look-and-feel options. |
| ::Database and server load and data volume that can be handled by one computer. | ::Managing a cluster of servers. | | ::Database and server load and data volume that can be handled by one computer. | ::Managing a cluster of servers. |
@ -218,5 +218,5 @@ over time.
### Project Plan ### Project Plan
See attached draft of [project plan](Project-Plan) See attached draft of [project plan](./Project-Plan.md)
and [resource needs](Resource-Needs). and [resource needs](./Resource-Needs.md).

108
src/ProductPlan/QA-Plan.md
View File

@ -5,7 +5,7 @@ those answers that do not apply._
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -14,22 +14,22 @@ those answers that do not apply._
##### Release Audience ##### Release Audience
- ::General availability release || - ::General availability release ||
- ::Customer-specific release: CUSTOMER(S) || - ::Customer-specific release: CUSTOMER(./S.md) ||
- ::Developer release (Internal usage only) || - ::Developer release (./Internal usage only.md) ||
- ::Early access release (Controlled external access) - ::Early access release (./Controlled external access.md)
##### Attached Worksheets ##### Attached Worksheets
- QA plan > [Review meeting notes](Review-Meeting-Notes) - QA plan > [Review meeting notes](./Review-Meeting-Notes.md)
- QA plan > [System test case suite](Test-Suite) - QA plan > [System test case suite](./Test-Suite.md)
- QA plan > [System test runs](Test-Run-Suite) - QA plan > [System test runs](./Test-Run-Suite.md)
##### Related Documents ##### Related Documents
- [Software Requirements Specification](SRS) - [Software Requirements Specification](./SRS.md)
- [Design](Design) - [Design](./Design.md)
- [Project plan](Project-Plan) - [Project plan](./Project-Plan.md)
- [Software development methodology](SDM) - [Software development methodology](./SDM.md)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -101,33 +101,33 @@ _TODO: Add or edit goals to fit your project. Group them by priorities
that make sense for your project on this particular release._ that make sense for your project on this particular release._
- ::Essential - ::Essential
- [Functionality > Correctness](Glossary-Standard-Terms#functionality--correctness) - [Functionality > Correctness](./Glossary-Standard-Terms#functionality--correctness.md)
- [Functionality > Robustness](Glossary-Standard-Terms#functionality--robustness) - [Functionality > Robustness](./Glossary-Standard-Terms#functionality--robustness.md)
- ::Expected - ::Expected
- [Functionality > Accuracy](Glossary-Standard-Terms#functionality--accuracy) - [Functionality > Accuracy](./Glossary-Standard-Terms#functionality--accuracy.md)
- [Functionality > Compatibility](Glossary-Standard-Terms#functionality--compatibility) - [Functionality > Compatibility](./Glossary-Standard-Terms#functionality--compatibility.md)
- [Functionality > Factual correctness](Glossary-Standard-Terms#functionality--factual-correctness) - [Functionality > Factual correctness](./Glossary-Standard-Terms#functionality--factual-correctness.md)
- [Usability > Understandability and Readability](Glossary-Standard-Terms#usability--understandability-and-readability) - [Usability > Understandability and Readability](./Glossary-Standard-Terms#usability--understandability-and-readability.md)
- [Usability > Learnability and Memorability](Glossary-Standard-Terms#usability--learnability-and-memorability) - [Usability > Learnability and Memorability](./Glossary-Standard-Terms#usability--learnability-and-memorability.md)
- [Usability > Task support](Glossary-Standard-Terms#usability--task-support) - [Usability > Task support](./Glossary-Standard-Terms#usability--task-support.md)
- [Usability > Efficiency](Glossary-Standard-Terms#usability--efficiency) - [Usability > Efficiency](./Glossary-Standard-Terms#usability--efficiency.md)
- [Usability > Safety](Glossary-Standard-Terms#usability--safety) - [Usability > Safety](./Glossary-Standard-Terms#usability--safety.md)
- [Usability > Consistency and Familiarity](Glossary-Standard-Terms#usability--consistency-and-familiarity) - [Usability > Consistency and Familiarity](./Glossary-Standard-Terms#usability--consistency-and-familiarity.md)
- [Usability > Subjective satisfaction](Glossary-Standard-Terms#usability--subjective-satisfaction) - [Usability > Subjective satisfaction](./Glossary-Standard-Terms#usability--subjective-satisfaction.md)
- [Security](Glossary-Standard-Terms#security) - [Security](./Glossary-Standard-Terms#security.md)
- ::Desired - ::Desired
- [Reliability > Consistency under load](Glossary-Standard-Terms#reliability--consistency-under-load) - [Reliability > Consistency under load](./Glossary-Standard-Terms#reliability--consistency-under-load.md)
- [Reliability > Consistency under concurrency](Glossary-Standard-Terms#reliability--consistency-under-concurrency) - [Reliability > Consistency under concurrency](./Glossary-Standard-Terms#reliability--consistency-under-concurrency.md)
- [Reliability > Availability under load](Glossary-Standard-Terms#reliability--availability-under-load) - [Reliability > Availability under load](./Glossary-Standard-Terms#reliability--availability-under-load.md)
- [Reliability > Longevity](Glossary-Standard-Terms#reliability--longevity) - [Reliability > Longevity](./Glossary-Standard-Terms#reliability--longevity.md)
- [Efficiency](Glossary-Standard-Terms#efficiency) - [Efficiency](./Glossary-Standard-Terms#efficiency.md)
- [Scalability](Glossary-Standard-Terms#scalability) - [Scalability](./Glossary-Standard-Terms#scalability.md)
- [Scalability > Performance under load](Glossary-Standard-Terms#scalability--performance-under-load) - [Scalability > Performance under load](./Glossary-Standard-Terms#scalability--performance-under-load.md)
- [Scalability > Large data volume](Glossary-Standard-Terms#scalability--large-data-volume) - [Scalability > Large data volume](./Glossary-Standard-Terms#scalability--large-data-volume.md)
- [Operability](Glossary-Standard-Terms#operability) - [Operability](./Glossary-Standard-Terms#operability.md)
- [Maintainability > Understandability](Glossary-Standard-Terms#maintainability--understandability) - [Maintainability > Understandability](./Glossary-Standard-Terms#maintainability--understandability.md)
- [Maintainability > Evolvability](Glossary-Standard-Terms#maintainability--evolvability) - [Maintainability > Evolvability](./Glossary-Standard-Terms#maintainability--evolvability.md)
- [Maintainability > Testability](Glossary-Standard-Terms#maintainability--testability) - [Maintainability > Testability](./Glossary-Standard-Terms#maintainability--testability.md)
### QA Strategy ### QA Strategy
@ -142,17 +142,17 @@ 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>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/) | | ::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.md), [lclint/splint](./http://www.splint.org/.md), [jlint](./http://artho.com/jlint/.md), [checkstyle](./http://sourceforge.net/projects/checkstyle/.md), [Jcsc](./http://sourceforge.net/projects/jcsc.md), [PyLint](./https://www.pylint.org/.md), [PyChecker](./http://pychecker.sourceforge.net/.md), [Tidy](./http://www.html-tidy.org/.md) |
| ::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.md) 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. |
| ::Manual system testing | <ul><li>::100% of UI screens and fields</li><li>::100% of specified requirements</li></ul> | ::The QA team will author and maintain a detailed written suite of manual tests to test the entire system through the user interface. This plan will be detailed enough that a person could repeatably carry out the tests from the test suite document and other associated documents. | | ::Manual system testing | <ul><li>::100% of UI screens and fields</li><li>::100% of specified requirements</li></ul> | ::The QA team will author and maintain a detailed written suite of manual tests to test the entire system through the user interface. This plan will be detailed enough that a person could repeatably carry out the tests from the test suite document and other associated documents. |
| ::Automated system testing | <ul><li>::100% of UI screens and fields</li><li>::100% of specified requirements</li></ul> | ::The QA team will use a system test automation tool to author and maintain a suite of test scripts to test the entire system through the user interface. | | ::Automated system testing | <ul><li>::100% of UI screens and fields</li><li>::100% of specified requirements</li></ul> | ::The QA team will use a system test automation tool to author and maintain a suite of test scripts to test the entire system through the user interface. |
| ::Regression testing | <ul><li>::Run all unit tests before each commit</li><li>::Run all unit tests nightly</li><li>::Add new unit test when verifying fixes</li></ul> | ::We will adopt a policy of frequently re-running all automated tests, including those that have previously been successful. This will help catch regressions (bugs that we thought were fixed, but that appear again). | | ::Regression testing | <ul><li>::Run all unit tests before each commit</li><li>::Run all unit tests nightly</li><li>::Add new unit test when verifying fixes</li></ul> | ::We will adopt a policy of frequently re-running all automated tests, including those that have previously been successful. This will help catch regressions (./bugs that we thought were fixed, but that appear again.md). |
| ::Load, stress, and capacity testing | <ul><li>::Simple load testing</li><li>::Detailed analysis of each scalability parameter</li></ul> | ::We use a load testing tool and/or custom scripts to simulate heavy usage of the system. Load will be defined by scalability parameters such as number of concurrent users, number of transactions per second, or number/size of data items stored/processed. We will verify that the system can handle loads within its capacity without crashing, producing incorrect results, mixing up results for distinct users, or corrupting the data. We will verify that when capacity limits are exceeded, the system safely rejects, ignores, or defers requests that it cannot handle. | | ::Load, stress, and capacity testing | <ul><li>::Simple load testing</li><li>::Detailed analysis of each scalability parameter</li></ul> | ::We use a load testing tool and/or custom scripts to simulate heavy usage of the system. Load will be defined by scalability parameters such as number of concurrent users, number of transactions per second, or number/size of data items stored/processed. We will verify that the system can handle loads within its capacity without crashing, producing incorrect results, mixing up results for distinct users, or corrupting the data. We will verify that when capacity limits are exceeded, the system safely rejects, ignores, or defers requests that it cannot handle. |
| ::Beta testing | <ul><li>::4 current customers</li><li>::40 members of our developers network</li><li>::1000 members of the public</li></ul> | ::We will involve outsiders in a beta test, or early access, program. We will beta testers directions to focus on specific features of the system. We will actively follow up with beta testers to encourage them to report issues. | | ::Beta testing | <ul><li>::4 current customers</li><li>::40 members of our developers network</li><li>::1000 members of the public</li></ul> | ::We will involve outsiders in a beta test, or early access, program. We will beta testers directions to focus on specific features of the system. We will actively follow up with beta testers to encourage them to report issues. |
| ::Instrumentation and monitoring | <ul><li>::Monitor our ASP servers</li><li>::Remotely monitor customer servers</li></ul> | ::As part of our SLA, we will monitor the behavior of servers to automatically detect service outages or performance degradation. We have policies and procedures in place for failure notification, escalation, and correction. | | ::Instrumentation and monitoring | <ul><li>::Monitor our ASP servers</li><li>::Remotely monitor customer servers</li></ul> | ::As part of our SLA, we will monitor the behavior of servers to automatically detect service outages or performance degradation. We have policies and procedures in place for failure notification, escalation, and correction. |
| ::Field failure reports | <ul><li>::Prompt users to report failures</li><li>::Automatically report failures</li></ul> | ::We want to understand each post-deployment system failure and actively take steps to correct the defect. The system has built-in capabilities for gathering detailed information from each system failure (e.g., error message, stack traceback, operating system version). This information will be transmitted back to us so that we may analyze it and act on it. | | ::Field failure reports | <ul><li>::Prompt users to report failures</li><li>::Automatically report failures</li></ul> | ::We want to understand each post-deployment system failure and actively take steps to correct the defect. The system has built-in capabilities for gathering detailed information from each system failure (./e.g., error message, stack traceback, operating system version.md). This information will be transmitted back to us so that we may analyze it and act on it. |
<!-- markdownlint-enable no-inline-html --> <!-- markdownlint-enable no-inline-html -->
### QA Strategy Evaluation ### QA Strategy Evaluation
@ -225,7 +225,7 @@ and tracked to completion._
- ::Each week, identify reviewers and schedule review meetings - ::Each week, identify reviewers and schedule review meetings
- ::Reviewers study the material individually for 2 hours - ::Reviewers study the material individually for 2 hours
- ::Reviewers meet to inspect the material for 2 hours - ::Reviewers meet to inspect the material for 2 hours
- ::Place [review meeting notes](Review-Meeting-Notes) in the - ::Place [review meeting notes](./Review-Meeting-Notes.md) in the
repository and track any issues identified in review meetings repository and track any issues identified in review meetings
3. Unit tests 3. Unit tests
@ -234,7 +234,7 @@ and tracked to completion._
just an Ant target) just an Ant target)
- ::Create unit tests for each class when the class is created - ::Create unit tests for each class when the class is created
- ::Execute unit tests before each commit. All tests must pass - ::Execute unit tests before each commit. All tests must pass
before developer can commit, otherwise open new issue(s) for before developer can commit, otherwise open new issue(./s.md) for
failed tests. These "smoke tests" will be executed in each failed tests. These "smoke tests" will be executed in each
developer's normal development environment. developer's normal development environment.
- ::Execute unit tests completely on each release candidate to check - ::Execute unit tests completely on each release candidate to check
@ -244,7 +244,7 @@ and tracked to completion._
4. System tests 4. System tests
- ::Design and specify a detailed manual [test suite](Test-Suite). - ::Design and specify a detailed manual [test suite](./Test-Suite.md).
- ::Review the system test suite to make sure that every UI screen - ::Review the system test suite to make sure that every UI screen
and element is covered and element is covered
- ::Execute system tests completely on each release candidate. These - ::Execute system tests completely on each release candidate. These
@ -255,14 +255,14 @@ and tracked to completion._
- ::Update this test plan whenever requirements change - ::Update this test plan whenever requirements change
- ::Document test results and communicate them to the entire - ::Document test results and communicate them to the entire
development team development team
- ::Estimate remaining (not yet detected) defects based on current - ::Estimate remaining (./not yet detected.md) defects based on current
issue tracking data, defect rates, and metrics on code size and issue tracking data, defect rates, and metrics on code size and
the impact of changes. the impact of changes.
- ::Keep all issues up-to-date in an issue tracking database. The - ::Keep all issues up-to-date in an issue tracking database. The
issue tracker is available to all project members issue tracker is available to all project members
[here](LINK-TO-ISSUE-TRACKER). The meaning of issue states, [here](./LINK-TO-ISSUE-TRACKER.md). The meaning of issue states,
priorities, and other attributes are defined in the priorities, and other attributes are defined in the
[SDM](SDM#issue-tracking). [SDM](./SDM#issue-tracking.md).
### QA-Plan Checklist ### QA-Plan Checklist
@ -273,16 +273,16 @@ that the quality goals will be satisfied. We will, of course, adjust
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.md) section of the
[Project Plan](Project-Plan). [Project Plan](./Project-Plan.md).
#### Have human resources been allocated to carry out the QA activities? #### Have human resources been allocated to carry out the QA activities?
::Yes, human resources have been allocated. They are listed in the ::Yes, human resources have been allocated. They are listed in the
[Resource Needs](Resource-Needs) document. [Resource Needs](./Resource-Needs.md) document.
::No, human resources have not been allocated. They are listed as ::No, human resources have not been allocated. They are listed as
"pending" in the [Resource Needs](Resource-Needs) document. "pending" in the [Resource Needs](./Resource-Needs.md) document.
#### Have machine and software resources been allocated as needed for the QA activities? #### Have machine and software resources been allocated as needed for the QA activities?
@ -290,10 +290,10 @@ in the [Risk Management](Project-Plan#Risk-Management) section of the
already allocated to them. already allocated to them.
::Yes, a QA Lab has been set up. The needed machine and software ::Yes, a QA Lab has been set up. The needed machine and software
resources are listed in the [Resource Needs](Resource-Needs) document. resources are listed in the [Resource Needs](./Resource-Needs.md) document.
::No, needed machine and software resources are listed as pending in ::No, needed machine and software resources are listed as pending in
the [Resource Needs](Resource-Needs) document. the [Resource Needs](./Resource-Needs.md) document.
#### Has this QA Plan been communicated to the development team and other stakeholders? #### Has this QA Plan been communicated to the development team and other stakeholders?
@ -306,5 +306,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.md) section of the
[Project Plan](Project-Plan). [Project Plan](./Project-Plan.md).

12
src/ProductPlan/Release-Checklist.md
View File

@ -6,7 +6,7 @@ those answers that do not apply._
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -19,9 +19,9 @@ those answers that do not apply._
##### Release audience ##### Release audience
- ::General availability release - ::General availability release
- ::Customer-specific release: CUSTOMER(S) - ::Customer-specific release: CUSTOMER(./S.md)
- ::Developer release (Internal usage only) - ::Developer release (./Internal usage only.md)
- ::Early access release (Controlled external access) - ::Early access release (./Controlled external access.md)
--- ---
@ -111,7 +111,7 @@ issue tracker._
| ----------------------------------------------------------------------------- | ------- | -------- | | ----------------------------------------------------------------------------- | ------- | -------- |
| ::Legal risks associated with this release have been identified and tracked | Pending | | | ::Legal risks associated with this release have been identified and tracked | Pending | |
| ::We hold proper licenses for all reused components and intellectual property | Pending | | | ::We hold proper licenses for all reused components and intellectual property | Pending | |
| ::We conform to all relevant laws and regulations (e.g., export, safety) | Pending | | | ::We conform to all relevant laws and regulations (./e.g., export, safety.md) | Pending | |
| ::The legal team is satisfied with this release | Pending | | | ::The legal team is satisfied with this release | Pending | |
#### Possible status values #### Possible status values
@ -129,7 +129,7 @@ that they will be explicitly managed on the next release. Conduct a
postmortem review to help expose difficulties rather than repeat them._ postmortem review to help expose difficulties rather than repeat them._
_TIP: You might consider some of the following additional stakeholders at _TIP: You might consider some of the following additional stakeholders at
your organization: Other engineering groups (i.e., hardware design), your organization: Other engineering groups (./i.e., hardware design.md),
Manufacturing and Shipping, Software Process Improvement, Key customers Manufacturing and Shipping, Software Process Improvement, Key customers
and partners, External developers, Risk Management, Business and partners, External developers, Risk Management, Business
Development, and Upper Management._ Development, and Upper Management._

50
src/ProductPlan/Release-Notes.md
View File

@ -8,7 +8,7 @@ number, not internal information._
##### Product ##### Product
::[PRODUCT-NAME](http://www.COMPANY.com/products/PRODUCT-NAME/) ::[PRODUCT-NAME](./http://www.COMPANY.com/products/PRODUCT-NAME/.md)
##### Release Number ##### Release Number
@ -21,7 +21,7 @@ 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/.md) or email us
at <support@COMPANY.com> at <support@COMPANY.com>
--- ---
@ -50,21 +50,21 @@ things may change in the future.
::This is the first full release of this product. See the product website ::This is the first full release of this product. See the product website
for a complete description. for a complete description.
::(WHEN X IN VERSION NUMBER CHANGES) This is a major release with many new ::(./WHEN X IN VERSION NUMBER CHANGES.md) This is a major release with many new
features. Users of previous releases should check the "Version features. Users of previous releases should check the "Version
Compatibility" section below for instructions on how to use existing Compatibility" section below for instructions on how to use existing
data with this new release. data with this new release.
::(WHEN Y IN VERSION NUMBER CHANGES) This is an upgrade release with some ::(./WHEN Y IN VERSION NUMBER CHANGES.md) This is an upgrade release with some
significant enhancements. Users of previous releases are encouraged to significant enhancements. Users of previous releases are encouraged to
upgrade. upgrade.
::(WHEN Z IN VERSION NUMBER CHANGES) This is a maintenance release that ::(./WHEN Z IN VERSION NUMBER CHANGES.md) This is a maintenance release that
improves quality, reliability, and performance without adding any new improves quality, reliability, and performance without adding any new
functionality. All users of previous X.Y releases should upgrade to this functionality. All users of previous X.Y releases should upgrade to this
release. release.
::(WHEN DEFECT CORRECTION CLOSES SIGNIFICANT SECURITY HOLES) This is a ::(./WHEN DEFECT CORRECTION CLOSES SIGNIFICANT SECURITY HOLES.md) This is a
critical upgrade release that addresses recently discovered security critical upgrade release that addresses recently discovered security
holes. All users of previous X.Y releases should upgrade immediately to holes. All users of previous X.Y releases should upgrade immediately to
this release. this release.
@ -79,8 +79,8 @@ information can be helpful._
- ::Added 4 new play-back modes - ::Added 4 new play-back modes
- ::Increased play-back speed by as much as 30% - ::Increased play-back speed by as much as 30%
- ::(FOR REUSABLE COMPONENTS ONLY) Streamlined build process - ::(./FOR REUSABLE COMPONENTS ONLY.md) Streamlined build process
- ::(FOR REUSABLE COMPONENTS ONLY) Roughly doubled unit test coverage - ::(./FOR REUSABLE COMPONENTS ONLY.md) Roughly doubled unit test coverage
- ::Many improvements to the product's quality, reliability, ease of - ::Many improvements to the product's quality, reliability, ease of
use, and performance. See "Recent Changes" below for details. use, and performance. See "Recent Changes" below for details.
@ -90,7 +90,7 @@ _TODO: Fill in these sections. The text here is only an example._
#### ::Installation #### ::Installation
::See the [installation instructions](Installation-Guide) for full details. ::See the [installation instructions](./Installation-Guide.md) for full details.
Please note that in this release, ... Please note that in this release, ...
::IMPORTANT: You must completely uninstall any previous "developer ::IMPORTANT: You must completely uninstall any previous "developer
@ -101,7 +101,7 @@ this release.
::This release consists of the following items: ::This release consists of the following items:
- ::Release notes (this file) - ::Release notes (./this file.md)
- ::Installation instructions / Quick start guide - ::Installation instructions / Quick start guide
- ::Product installer binary - ::Product installer binary
- ::User guide - ::User guide
@ -123,7 +123,7 @@ this release.
#### ::Operating System #### ::Operating System
::Windows 2000, Windows XP, Mac OS X, Linux (kernel 2.4) ::Windows 2000, Windows XP, Mac OS X, Linux (./kernel 2.4.md)
#### ::Networking #### ::Networking
@ -132,8 +132,8 @@ this release.
#### ::Existing Software #### ::Existing Software
- ::Standard e-mail client - ::Standard e-mail client
- ::Popular web browser (IE6, NN7) - ::Popular web browser (./IE6, NN7.md)
- ::SuperWaveEdit(TM) 2.0.2 (Needed for custom playback modes) - ::SuperWaveEdit(./TM.md) 2.0.2 (./Needed for custom playback modes.md)
#### ::Version Compatibility #### ::Version Compatibility
@ -151,13 +151,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](#tbd) Screen frozen when caps-lock is on - ::FIX [09823](./#tbd.md) Screen frozen when caps-lock is on
- ::FIX [09912](#tbd) Static heard while downloading - ::FIX [09912](./#tbd.md) Static heard while downloading
- ::FIX [10923](#tbd) Repeat-mode cannot play more than 99 times - ::FIX [10923](./#tbd.md) Repeat-mode cannot play more than 99 times
- ::ENHANCEMENT [08237](#tbd) Scratch DJ-mode - ::ENHANCEMENT [08237](./#tbd.md) Scratch DJ-mode
- ::ENHANCEMENT [08238](#tbd) Chill DJ-mode - ::ENHANCEMENT [08238](./#tbd.md) Chill DJ-mode
- ::ENHANCEMENT [08259](#tbd) Retro stereo-mode - ::ENHANCEMENT [08259](./#tbd.md) Retro stereo-mode
- ::ENHANCEMENT [10202](#tbd) Techno-mode - ::ENHANCEMENT [10202](./#tbd.md) Techno-mode
### Known Problems and Workarounds ### Known Problems and Workarounds
@ -166,11 +166,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](#tbd) Player skips on very loud playback. - ::DEFECT [07293](./#tbd.md) Player skips on very loud playback.
- ::WORKAROUND: Limit volume to settings 1 through 9. - ::WORKAROUND: Limit volume to settings 1 through 9.
- ::DEFECT [10509](#tbd) Cannot switch directly from random play mode to - ::DEFECT [10509](./#tbd.md) Cannot switch directly from random play mode to
Internet play-list. Internet play-list.
- ::WORKAROUND: Switch to local play-list first. Click [here](#tbd) for - ::WORKAROUND: Switch to local play-list first. Click [here](./#tbd.md) for
detailed instructions. detailed instructions.
- ::DEFECT [10589](#tbd) Static heard while booting - ::DEFECT [10589](./#tbd.md) Static heard while booting
- ::DEFECT [10944](#tbd) Repeat-mode cannot play more than 999 times - ::DEFECT [10944](./#tbd.md) Repeat-mode cannot play more than 999 times

16
src/ProductPlan/Resource-Needs.md
View File

@ -2,7 +2,7 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -14,11 +14,11 @@
##### Related Documents ##### Related Documents
- [Project proposal](Proposal) - [Project proposal](./Proposal.md)
- [Project plan](Project-Plan) - [Project plan](./Project-Plan.md)
- [QA plan](QA-Plan) - [QA plan](./QA-Plan.md)
- [Software development methodology](SDM) - [Software development methodology](./SDM.md)
- [Glossary](Glossary) - [Glossary](./Glossary.md)
--- ---
@ -91,7 +91,7 @@ otherwise be missed. It does not help with the actual estimated number
of hours needed. Those estimates should be based on the project plan. of hours needed. Those estimates should be based on the project plan.
_TODO: Answer the questions below. If multiple sample answers are _TODO: Answer the questions below. If multiple sample answers are
provided, [chip away](Glossary-Standard-Terms#chipping-away) the ones that do provided, [chip away](./Glossary-Standard-Terms#chipping-away.md) the ones that do
not apply. Edit any provided answers as needed. Use this exercise to not apply. Edit any provided answers as needed. Use this exercise to
help you fill in the tables above._ help you fill in the tables above._
@ -297,4 +297,4 @@ is likely to need the same resources.
:: Yes, everyone understands. Feedback is welcome. :: Yes, everyone understands. Feedback is welcome.
:: No, this is a risk that is noted in the [Risk :: No, this is a risk that is noted in the [Risk
Management](Project-Plan#Risk-Management) section. Management](./Project-Plan#Risk-Management.md) section.

20
src/ProductPlan/Review-Meeting-Checklists.md
View File

@ -4,18 +4,18 @@
## 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.md)
by Karl E. Wiegers by Karl E. Wiegers
- ::[Checklists for UML design](http://www.modelingstyle.info/) - ::[Checklists for UML design](./http://www.modelingstyle.info/.md)
by Scott W. Ambler by Scott W. Ambler
## Style Guides ## Style Guides
- ::[Sun's java style guide](http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html) - ::[Sun's java style guide](./http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html.md)
- ::[Sun's javadoc guide](http://java.sun.com/j2se/javadoc/writingdoccomments/) - ::[Sun's javadoc guide](./http://java.sun.com/j2se/javadoc/writingdoccomments/.md)
- ::[PHPBuilder.com's PHP style guide](http://www.phpbuilder.com/columns/tim20010101.php3) - ::[PHPBuilder.com's PHP style guide](./http://www.phpbuilder.com/columns/tim20010101.php3.md)
- ::[Alltasks.net PHP style guide](http://alltasks.net/code/php_coding_standard.html) - ::[Alltasks.net PHP style guide](./http://alltasks.net/code/php_coding_standard.html.md)
- ::[C\# style guide](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions) - ::[C\# style guide](./https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions.md)
- ::[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/.md)
- ::[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/.md)
- ::[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/.md)

16
src/ProductPlan/Review-Meeting-Notes.md
View File

@ -2,7 +2,7 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Release Number ##### Release Number
@ -25,18 +25,18 @@
##### Related Documents ##### Related Documents
- [QA Plan](QA-Plan) > Review Meeting Notes - [QA Plan](./QA-Plan.md) > Review Meeting Notes
- [Review Meeting Checklists](Review-Meeting-Checklists) - [Review Meeting Checklists](./Review-Meeting-Checklists.md)
--- ---
### Documents and Code Reviewed at this Meeting ### Documents and Code Reviewed at this Meeting
- ::[Feature list section of requirements](#tbd) - ::[Feature list section of requirements](./#tbd.md)
- ::[Multi-user section of requirements](#tbd) - ::[Multi-user section of requirements](./#tbd.md)
- ::[Hello.java](/source/browse/PROJECT-NAME/src/Hello.java) - ::[Hello.java](.//source/browse/PROJECT-NAME/src/Hello.java.md)
- ::[HelloStream.java](/source/browse/PROJECT-NAME/src/HelloStream.java) - ::[HelloStream.java](.//source/browse/PROJECT-NAME/src/HelloStream.java.md)
- ::[HelloPanel.java](/source/browse/PROJECT-NAME/src/HelloPanel.java) - ::[HelloPanel.java](.//source/browse/PROJECT-NAME/src/HelloPanel.java.md)
### Meeting Minutes ### Meeting Minutes

14
src/ProductPlan/Risks.md
View File

@ -1,7 +1,7 @@
<!-- markdownlint-disable-next-line first-line-h1 --> <!-- markdownlint-disable-next-line first-line-h1 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -9,13 +9,13 @@
##### Related Documents ##### Related Documents
- [Project plan](Project-Plan) - [Project plan](./Project-Plan.md)
- [Software development methodology](SDM) - [Software development methodology](./SDM.md)
##### 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.md) 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.md) by Carr, Konda, Monarch, Ulrich, and Walker (./SEI.md)
--- ---
@ -78,7 +78,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.md) to help communication. The main indicator of miscommunication will be software defects detected by our [QA activity](./qa-plan.md). | 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 |
@ -91,7 +91,7 @@ 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.md). 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 | | ::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 |
| ::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 to new development. Contingency: request customer review of requirements. | Green | Project Manager |

26
src/ProductPlan/SDM.md
View File

@ -9,17 +9,17 @@
###### Related Documents ###### Related Documents
- [The Scrum Guide](https://www.scrumguides.org/scrum-guide.html) - [The Scrum Guide](./https://www.scrumguides.org/scrum-guide.html.md)
- [The Agile Manifesto](https://agilemanifesto.org) - [The Agile Manifesto](./https://agilemanifesto.org.md)
- [Agile Documentation: Methodology & Best Practices](https://document360.com/blog/agile-documentation) - [Agile Documentation: Methodology & Best Practices](./https://document360.com/blog/agile-documentation.md)
- [Scrum Documentation Template](https://www.infotech.com/research/scrum-documentation-template) - [Scrum Documentation Template](./https://www.infotech.com/research/scrum-documentation-template.md)
- [What is Agile Scrum Methodology?](https://www.inflectra.com/Methodologies/Scrum.aspx) - [What is Agile Scrum Methodology?](./https://www.inflectra.com/Methodologies/Scrum.aspx.md)
- [Glossary](Glossary) - [Glossary](./Glossary.md)
### Table of Contents ### Table of Contents
- [Introduction](SDM#1-introduction) - [Introduction](./SDM#1-introduction.md)
- [Purpose](SDM#11-purpose) - [Purpose](./SDM#11-purpose.md)
- Scope - Scope
- Audience - Audience
- Document Overview - Document Overview
@ -137,7 +137,7 @@ Scrum utilizes three essential artifacts to facilitate a clear understanding of
##### Product Backlog ##### Product Backlog
- Purpose: The Product Backlog is a dynamic and prioritized list of all the work items (user stories, features, bug fixes, improvements) needed to be completed for the product. It represents the requirements and the vision of the product. - Purpose: The Product Backlog is a dynamic and prioritized list of all the work items (./user stories, features, bug fixes, improvements.md) needed to be completed for the product. It represents the requirements and the vision of the product.
- Importance: The Product Backlog acts as the single source of truth for the development team and stakeholders, ensuring a shared understanding of the product's scope and priorities. It enables transparency and allows for the continuous inspection and adaptation of the project's requirements. - Importance: The Product Backlog acts as the single source of truth for the development team and stakeholders, ensuring a shared understanding of the product's scope and priorities. It enables transparency and allows for the continuous inspection and adaptation of the project's requirements.
##### Sprint Backlog ##### Sprint Backlog
@ -157,7 +157,7 @@ Scrum utilizes three essential artifacts to facilitate a clear understanding of
- Objective: The primary objective of Sprint Planning is to define what the Development Team will work on during the upcoming Sprint. It involves collaborative discussions between the Product Owner and the Development Team to select the most valuable Product Backlog items to be delivered in the Sprint. - Objective: The primary objective of Sprint Planning is to define what the Development Team will work on during the upcoming Sprint. It involves collaborative discussions between the Product Owner and the Development Team to select the most valuable Product Backlog items to be delivered in the Sprint.
- Contribution to Team's Success: Sprint Planning ensures that the team has a clear understanding of the Sprint Goal and the scope of work for the Sprint. By collaboratively selecting and committing to work items, the team gains a sense of ownership and accountability for achieving the Sprint Goal. This event sets the direction for the Sprint and helps the team stay focused on delivering the highest value increments. - Contribution to Team's Success: Sprint Planning ensures that the team has a clear understanding of the Sprint Goal and the scope of work for the Sprint. By collaboratively selecting and committing to work items, the team gains a sense of ownership and accountability for achieving the Sprint Goal. This event sets the direction for the Sprint and helps the team stay focused on delivering the highest value increments.
##### Daily Stand-up (Daily Scrum) ##### Daily Stand-up (./Daily Scrum.md)
- Objective: The Daily Stand-up is a short, time-boxed meeting held every day during the Sprint. The objective is to facilitate communication and collaboration within the Development Team by providing a forum to share progress, discuss any impediments, and synchronize efforts. - Objective: The Daily Stand-up is a short, time-boxed meeting held every day during the Sprint. The objective is to facilitate communication and collaboration within the Development Team by providing a forum to share progress, discuss any impediments, and synchronize efforts.
- Contribution to Team's Success: The Daily Stand-up promotes transparency and fosters a shared understanding of the team's progress and challenges. It enables quick identification and resolution of obstacles, promoting a sense of teamwork and collective accountability. The event helps the team stay on track towards achieving the Sprint Goal, and it encourages a culture of continuous improvement by addressing issues as they arise. - Contribution to Team's Success: The Daily Stand-up promotes transparency and fosters a shared understanding of the team's progress and challenges. It enables quick identification and resolution of obstacles, promoting a sense of teamwork and collective accountability. The event helps the team stay on track towards achieving the Sprint Goal, and it encourages a culture of continuous improvement by addressing issues as they arise.
@ -248,7 +248,7 @@ Create a collaborative work environment where team members feel comfortable shar
During Sprint Planning, the Product Owner collaborates with the Development Team to discuss the items from the Product Backlog and define the Sprint Goal. The team members contribute their insights, estimations, and concerns to ensure a shared understanding of what needs to be achieved in the upcoming Sprint. During Sprint Planning, the Product Owner collaborates with the Development Team to discuss the items from the Product Backlog and define the Sprint Goal. The team members contribute their insights, estimations, and concerns to ensure a shared understanding of what needs to be achieved in the upcoming Sprint.
##### Definition of Done (DoD) ##### Definition of Done (./DoD.md)
Establish a clear and agreed-upon Definition of Done that defines the criteria for a Product Backlog item to be considered complete. This shared understanding ensures that all team members know what is expected and can work together to meet the DoD for each increment. Establish a clear and agreed-upon Definition of Done that defines the criteria for a Product Backlog item to be considered complete. This shared understanding ensures that all team members know what is expected and can work together to meet the DoD for each increment.
@ -278,7 +278,7 @@ Organize knowledge sharing sessions or workshops within the team to facilitate t
##### Agile Ceremonies and Artifacts ##### Agile Ceremonies and Artifacts
Use Agile ceremonies (e.g., Sprint Planning, Daily Stand-up, Sprint Review, and Sprint Retrospective) and Scrum artifacts (e.g., Product Backlog, Sprint Backlog) as tools for collaboration, transparency, and continuous alignment with project goals. Use Agile ceremonies (./e.g., Sprint Planning, Daily Stand-up, Sprint Review, and Sprint Retrospective.md) and Scrum artifacts (./e.g., Product Backlog, Sprint Backlog.md) as tools for collaboration, transparency, and continuous alignment with project goals.
By fostering a collaborative environment, promoting cross-functional expertise, and leveraging Agile practices, the Scrum Team can ensure effective collaboration, shared understanding of project goals, and a focus on delivering high-quality increments that meet the needs of stakeholders. Collaboration within the team is a cornerstone of Scrum, enabling it to adapt and succeed in a dynamic and changing environment. By fostering a collaborative environment, promoting cross-functional expertise, and leveraging Agile practices, the Scrum Team can ensure effective collaboration, shared understanding of project goals, and a focus on delivering high-quality increments that meet the needs of stakeholders. Collaboration within the team is a cornerstone of Scrum, enabling it to adapt and succeed in a dynamic and changing environment.
@ -300,7 +300,7 @@ Backlog refinement, also known as "Backlog Grooming," is an ongoing process wher
##### Involvement of the Product Owner ##### Involvement of the Product Owner
The Product Owner (PO) is primarily responsible for managing the Product Backlog. Their involvement includes: The Product Owner (./PO.md) is primarily responsible for managing the Product Backlog. Their involvement includes:
- Defining and Communicating Vision: The PO defines the product vision and communicates it to the team and stakeholders. The vision serves as a guide for prioritizing the items in the Product Backlog based on their alignment with the product's overall goals. - Defining and Communicating Vision: The PO defines the product vision and communicates it to the team and stakeholders. The vision serves as a guide for prioritizing the items in the Product Backlog based on their alignment with the product's overall goals.

38
src/ProductPlan/SRS.md
View File

@ -9,24 +9,24 @@
##### Attached worksheets ##### Attached worksheets
- SRS > [Use case suite](Use-Case-Suite) - SRS > [Use case suite](./Use-Case-Suite.md)
- SRS > [Feature set](Feature-Set) - SRS > [Feature set](./Feature-Set.md)
##### Related Documents ##### Related Documents
- [Project proposal](Proposal) > [User needs](User-Needs) - [Project proposal](./Proposal.md) > [User needs](./User-Needs.md)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
- [Glossary](Glossary) - [Glossary](./Glossary.md)
--- ---
**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.md) and [user
needs](User-Needs) documents. The SRS sets requirements that must needs](./User-Needs.md) 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.md). The SRS is verified
and validated by activities outlined in the [QA plan](QA-Plan). and validated by activities outlined in the [QA plan](./QA-Plan.md).
### Introduction ### Introduction
@ -37,7 +37,7 @@ copy text from the project proposal, paste it here, and shorten it._
::PARAGRAPH ::PARAGRAPH
For more information, see the project [proposal](Proposal). For more information, see the project [proposal](./Proposal.md).
### Use Cases ### Use Cases
@ -45,8 +45,8 @@ For more information, see the project [proposal](Proposal).
Details: Details:
- Actors are described in the [user needs](User-Needs) document. - Actors are described in the [user needs](./User-Needs.md) document.
- The [use case suite](Use-Case-Suite) lists all use cases in an - The [use case suite](./Use-Case-Suite.md) lists all use cases in an
organized way. organized way.
### Functional Requirements ### Functional Requirements
@ -55,7 +55,7 @@ Details:
Details: Details:
- The [feature set](Feature-Set) lists all features in an - The [feature set](./Feature-Set.md) lists all features in an
organized way. organized way.
### Non-Functional Requirements ### Non-Functional Requirements
@ -82,9 +82,9 @@ and dialog boxes whenever possible.
Details: Details:
- ::Government customers will demand [section508 - ::Government customers will demand [section508
compliance](http://www.section508.gov/) compliance](./http://www.section508.gov/.md)
- ::Support learnability with principles of [Instructive - ::Support learnability with principles of [Instructive
Interaction](http://www.foruse.com/articles/instructive.htm) Interaction](./http://www.foruse.com/articles/instructive.htm.md)
- ::The customer wants extensive on-line help, but is not demanding - ::The customer wants extensive on-line help, but is not demanding
a printed manual. a printed manual.
@ -122,7 +122,7 @@ functions, average users will not.
Details: Details:
- ::Passwords must be 4-14 characters long - ::Passwords must be 4-14 characters long
- ::We will not use encrypted communications (SSL) for this website - ::We will not use encrypted communications (./SSL.md) for this website
- ::DETAIL - ::DETAIL
#### What are the performance and scalability requirements requirements? #### What are the performance and scalability requirements requirements?
@ -169,7 +169,7 @@ checklist of information to have at hand before contacting
technical support. technical support.
::Operability is our ability to host and operate the software as an ::Operability is our ability to host and operate the software as an
ASP (Application Service Provider). The product features should help ASP (./Application Service Provider.md). The product features should help
us achieve our goal of 99.9% uptime (at most 43 minutes downtime us achieve our goal of 99.9% uptime (at most 43 minutes downtime
each month). Key features supporting that are the ability to do hot each month). Key features supporting that are the ability to do hot
data backups, and application monitoring. data backups, and application monitoring.
@ -228,7 +228,7 @@ Details:
- ::DETAIL - ::DETAIL
- ::DETAIL - ::DETAIL
#### What application program interfaces ([APIs](Glossary-Standard-Terms#api_application_programming_interface)) must be provided? #### What application program interfaces (./[APIs](Glossary-Standard-Terms#api_application_programming_interface.md)) must be provided?
::PARAGRAPH ::PARAGRAPH
@ -236,7 +236,7 @@ Details:
Details: Details:
- ::We must implement this [standard API](LINK-TO-STANDARD). - ::We must implement this [standard API](./LINK-TO-STANDARD.md).
- ::DETAIL - ::DETAIL
- ::DETAIL - ::DETAIL
@ -251,7 +251,7 @@ 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.md).
- ::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

8
src/ProductPlan/Scrum-Guide.md
View File

@ -376,13 +376,13 @@ A product is a vehicle to deliver value. It has a clear boundary, known stakehol
users or customers. A product could be a service, a physical product, or something more abstract. users or customers. A product could be a service, a physical product, or something more abstract.
``` ```
The Product Goal is the long-term objective for the Scrum Team. They must fulfill (or abandon) one The Product Goal is the long-term objective for the Scrum Team. They must fulfill (./or abandon.md) one
objective before taking on the next. objective before taking on the next.
### Sprint Backlog ### Sprint Backlog
The Sprint Backlog is composed of the Sprint Goal (why), the set of Product Backlog items selected for The Sprint Backlog is composed of the Sprint Goal (./why.md), the set of Product Backlog items selected for
the Sprint (what), as well as an actionable plan for delivering the Increment (how). the Sprint (./what.md), as well as an actionable plan for delivering the Increment (./how.md).
The Sprint Backlog is a plan by and for the Developers. It is a highly visible, real-time picture of the work The Sprint Backlog is a plan by and for the Developers. It is a highly visible, real-time picture of the work
that the Developers plan to accomplish during the Sprint in order to achieve the Sprint Goal. that the Developers plan to accomplish during the Sprint in order to achieve the Sprint Goal.
@ -459,7 +459,7 @@ the Scrum framework. These may increase productivity, value, creativity, and sat
results. results.
The complete history of Scrum is described elsewhere. To honor the first places where it was tried and The complete history of Scrum is described elsewhere. To honor the first places where it was tried and
proven, we recognize Individual Inc., Newspage, Fidelity Investments, and IDX (now GE Medical). proven, we recognize Individual Inc., Newspage, Fidelity Investments, and IDX (./now GE Medical.md).
```markdown ```markdown
© 2020 Ken Schwaber and Jeff Sutherland © 2020 Ken Schwaber and Jeff Sutherland

50
src/ProductPlan/Status-Report.md
View File

@ -9,7 +9,7 @@ examples are given, you should select/edit only one._
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Status Report Date ##### Status Report Date
@ -27,20 +27,20 @@ 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.md)
- ::[17 defects](ISSUE-TRACKER-QUERY) - ::[17 defects](./ISSUE-TRACKER-QUERY.md)
- ::[8 enhancements](#tbd) - ::[8 enhancements](./#tbd.md)
##### Resolved Issues (pending verification) ##### Resolved Issues (./pending verification.md)
- ::[0 defects](#tbd) - ::[0 defects](./#tbd.md)
- ::[2 enhancements](#tbd) - ::[2 enhancements](./#tbd.md)
##### Closed Issues ##### Closed Issues
- ::[34 defects](#tbd) - ::[34 defects](./#tbd.md)
- ::[3 enhancements](#tbd) - ::[3 enhancements](./#tbd.md)
##### Resources used this period ##### Resources used this period
@ -59,9 +59,9 @@ examples are given, you should select/edit only one._
##### Related Documents ##### Related Documents
- [Project plan](Project-Plan) > [Resource needs](Resource-Needs) - [Project plan](./Project-Plan.md) > [Resource needs](./Resource-Needs.md)
- [QA plan](QA-Plan) - [QA plan](./QA-Plan.md)
- [Glossary](Glossary) - [Glossary](./Glossary.md)
--- ---
@ -84,14 +84,14 @@ words.
::The reason for the change in estimated release date is... ::The reason for the change in estimated release date is...
::To stay on schedule, we have slipped enhancements [issue92](ISSUE-TRACKER-URL), ::To stay on schedule, we have slipped enhancements [issue92](./ISSUE-TRACKER-URL.md),
[issue 101](ISSUE-TRACKER-URL), and [issue 129](ISSUE-TRACKER-URL) to a later [issue 101](./ISSUE-TRACKER-URL.md), and [issue 129](./ISSUE-TRACKER-URL.md) to a later
release. These issues were selected because ... release. These issues were selected because ...
### Risk Management ### Risk Management
_TODO: List 3-10 of the top project risks that are still outstanding. _TODO: List 3-10 of the top project risks that are still outstanding.
This list may be an **updated** copy from [project plan](Project-Plan.html#Risk-Management) This list may be an **updated** copy from [project plan](./Project-Plan.html#Risk-Management.md)
or a previous status report._ or a previous status report._
- ::We could face major difficulties with the technology chosen for - ::We could face major difficulties with the technology chosen for
@ -110,10 +110,10 @@ the next status report. The text below is just an example, replace it
with your own words. Link to open issues in the issue tracker whenever with your own words. Link to open issues in the issue tracker whenever
possible._ possible._
- ::Fix [issue 130](ISSUE-TRACKER-URL) - ::Fix [issue 130](./ISSUE-TRACKER-URL.md)
- ::Fix [issue 133](ISSUE-TRACKER-URL) - ::Fix [issue 133](./ISSUE-TRACKER-URL.md)
- ::Verify [issue 102](ISSUE-TRACKER-URL), [issue 103](ISSUE-TRACKER-URL), - ::Verify [issue 102](./ISSUE-TRACKER-URL.md), [issue 103](./ISSUE-TRACKER-URL.md),
[issue 107](ISSUE-TRACKER-URL), and [issue 109](ISSUE-TRACKER-URL) [issue 107](./ISSUE-TRACKER-URL.md), and [issue 109](./ISSUE-TRACKER-URL.md)
- ::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
- ::Make major progress on COMPONENT - ::Make major progress on COMPONENT
@ -124,7 +124,7 @@ possible._
### Tracking to Plan ### Tracking to Plan
_TODO: Copy the Work Breakdown Structure from the [project plan](Project-Plan) and paste it here. _TODO: Copy the Work Breakdown Structure from the [project plan](./Project-Plan.md) and paste it here.
Add a new column for actual effort spent so far by all team members._ Add a new column for actual effort spent so far by all team members._
| Step | Description | Planned Hours | Spent To-Date | | Step | Description | Planned Hours | Spent To-Date |
@ -137,7 +137,7 @@ Add a new column for actual effort spent so far by all team members._
| ::2.3. | ::Requirements validation | ::10h | ::0h | | ::2.3. | ::Requirements validation | ::10h | ::0h |
| ::3. | ::Elaboration | | | | ::3. | ::Elaboration | | |
| ::3.1. | ::High-level design | ::5h | ::0h | | ::3.1. | ::High-level design | ::5h | ::0h |
| ::3.2. | ::Low-level design (break down by component) | | | | ::3.2. | ::Low-level design (./break down by component.md) | | |
| ::3.2.A. | ::Object design | ::10h | ::0h | | ::3.2.A. | ::Object design | ::10h | ::0h |
| ::3.2.B. | ::User interface design | ::10h | ::0h | | ::3.2.B. | ::User interface design | ::10h | ::0h |
| ::3.2.C. | ::Database design | ::3h | ::0h | | ::3.2.C. | ::Database design | ::3h | ::0h |
@ -148,12 +148,12 @@ Add a new column for actual effort spent so far by all team members._
| ::4.1.A.2. | ::Implement Component 2 | ::25h | ::0h | | ::4.1.A.2. | ::Implement Component 2 | ::25h | ::0h |
| ::4.1.A.3. | ::Implement Component 3 | ::25h | ::0h | | ::4.1.A.3. | ::Implement Component 3 | ::25h | ::0h |
| ::4.1.A.4. | ::Implement Component 4 | ::25h | ::0h | | ::4.1.A.4. | ::Implement Component 4 | ::25h | ::0h |
| ::4.1.A.5. | ::Integrate Components (mostly done during component implementation) | ::5h | ::0h | | ::4.1.A.5. | ::Integrate Components (./mostly done during component implementation.md) | ::5h | ::0h |
| ::4.1.B. | ::Technical documentation (break down by component) | ::10h | ::0h | | ::4.1.B. | ::Technical documentation (./break down by component.md) | ::10h | ::0h |
| ::4.1.C. | ::User documentation (break down by component) | ::10h | ::0h | | ::4.1.C. | ::User documentation (./break down by component.md) | ::10h | ::0h |
| ::4.1.D. | ::Testing | | | | ::4.1.D. | ::Testing | | |
| ::4.1.D.1. | ::Test planning | ::10h | ::0h | | ::4.1.D.1. | ::Test planning | ::10h | ::0h |
| ::4.1.D.2. | ::Test code implementation (break down by component) | ::30h | ::0h | | ::4.1.D.2. | ::Test code implementation (./break down by component.md) | ::30h | ::0h |
| ::4.1.D.3. | ::Test execution | ::10h | ::0h | | ::4.1.D.3. | ::Test execution | ::10h | ::0h |
| ::4.2. | ::Implementation review and evaluation | ::15h | ::0h | | ::4.2. | ::Implementation review and evaluation | ::15h | ::0h |
| ::5. | ::Transition | | | | ::5. | ::Transition | | |

68
src/ProductPlan/Summary.md
View File

@ -3,7 +3,7 @@
### 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.md)._
#### What problem does this project address? #### What problem does this project address?
@ -23,22 +23,22 @@ _TODO: Briefly describe the status of this project. E.g., what phase are you in?
::We have completed our second beta release and are currently working on ::We have completed our second beta release and are currently working on
adding more of the functionality described in our product adding more of the functionality described in our product
[specification](SRS) and fixing defects. [specification](./SRS.md) and fixing defects.
::The next major milestone is a third beta release with nearly complete ::The next major milestone is a third beta release with nearly complete
functionality and a wider set of testers. functionality and a wider set of testers.
#### Status reports #### Status reports
- ::[Status report 1](status-report.html) - ::[Status report 1](./status-report.html.md)
- ::[Status report 2](status-report2.html) - ::[Status report 2](./status-report2.html.md)
- ::Etc. - ::Etc.
### 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.md), [resource needs](./Resource-Needs.md),
and [legal issues](legal.html) documents._ and [legal issues](./legal.html.md) documents._
#### What are the deadlines for this project? #### What are the deadlines for this project?
@ -69,10 +69,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.md),
[interview notes](interview-notes.html), [SRS](SRS), [interview notes](./interview-notes.html.md), [SRS](./SRS.md),
[use case suite](Use-Case-Suite), [use case suite](./Use-Case-Suite.md),
and [feature set](Feature-Set) documents._ and [feature set](./Feature-Set.md) documents._
#### Who are the project stakeholders? #### Who are the project stakeholders?
@ -83,20 +83,20 @@ and [feature set](Feature-Set) documents._
#### What user needs have you gathered? #### What user needs have you gathered?
- ::[User stories](LINK-TO-USER-STORIES) - ::[User stories](./LINK-TO-USER-STORIES.md)
- ::[Interview notes](LINK-TO-INTERVIEW-NOTES) - ::[Interview notes](./LINK-TO-INTERVIEW-NOTES.md)
#### What are the requirements specifications? #### What are the requirements specifications?
- ::[Use cases](LINK-TO-USE-CASES) - ::[Use cases](./LINK-TO-USE-CASES.md)
- ::[Feature specifications](LINK-TO-FEATURE-SPECS) - ::[Feature specifications](./LINK-TO-FEATURE-SPECS.md)
- ::[Environmental requirements](LINK-TO-ENV-REQ) - ::[Environmental requirements](./LINK-TO-ENV-REQ.md)
- ::[Other requirements](LINK-TO-OTHER-REQ) - ::[Other requirements](./LINK-TO-OTHER-REQ.md)
### Design ### Design
_TODO: Briefly describe the most important aspects of the design. This is _TODO: Briefly describe the most important aspects of the design. This is
condensed from the [design](Design) template and associated condensed from the [design](./Design.md) template and associated
worksheets._ worksheets._
#### What are your ranked design goals? #### What are your ranked design goals?
@ -131,18 +131,18 @@ worksheets._
#### Where are your design documents? #### Where are your design documents?
- ::[UML class diagram](LINK-TO-CLASS-DIAGRAM) - ::[UML class diagram](./LINK-TO-CLASS-DIAGRAM.md)
- ::[UML class diagram](LINK-TO-CLASS-DIAGRAM) - ::[UML class diagram](./LINK-TO-CLASS-DIAGRAM.md)
- ::[UML state diagram](LINK-TO-STATE-DIAGRAM) - ::[UML state diagram](./LINK-TO-STATE-DIAGRAM.md)
- ::[UML sequence diagram](LINK-TO-SEQUENCE-DIAGRAM) - ::[UML sequence diagram](./LINK-TO-SEQUENCE-DIAGRAM.md)
- ::[UML deployment diagram](LINK-TO-DEPLOYMENT-DIAGRAM) - ::[UML deployment diagram](./LINK-TO-DEPLOYMENT-DIAGRAM.md)
- ::[Other design](LINK-TO-OTHER-DESIGN) - ::[Other design](./LINK-TO-OTHER-DESIGN.md)
### 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), [test This is condensed from the [QA plan](./QA-Plan.md), [test
suite](test-suite), and [test cases](test-cases.html) documents._ suite](./test-suite.md), and [test cases](./test-cases.html.md) documents._
#### What are your ranked quality goals? #### What are your ranked quality goals?
@ -167,22 +167,22 @@ suite](test-suite), and [test cases](test-cases.html) documents._
#### Where are the test cases? #### Where are the test cases?
- ::[Test case](LINK-TO-TEST-CASE) - ::[Test case](./LINK-TO-TEST-CASE.md)
- ::[Test case](LINK-TO-TEST-CASE) - ::[Test case](./LINK-TO-TEST-CASE.md)
- ::[Test case](LINK-TO-TEST-CASE) - ::[Test case](./LINK-TO-TEST-CASE.md)
- ::[Test case](LINK-TO-TEST-CASE) - ::[Test case](./LINK-TO-TEST-CASE.md)
### Packaging, Delivery, and Deployment ### Packaging, Delivery, and Deployment
Where is the release checklist or sign-off document? Where is the release checklist or sign-off document?
::[Release checklist](LINK-TO-RELEASE-CHECKLIST) ::[Release checklist](./LINK-TO-RELEASE-CHECKLIST.md)
#### How is the product packaged and deployed? #### How is the product packaged and deployed?
- ::Packaging: DESCRIPTION - ::Packaging: DESCRIPTION
- ::Deployment: DESCRIPTION - ::Deployment: DESCRIPTION
- ::[Release notes](LINK-TO-RELEASE-NOTES) - ::[Release notes](./LINK-TO-RELEASE-NOTES.md)
#### How is the product installed? #### How is the product installed?
@ -195,8 +195,8 @@ Where is the release checklist or sign-off document?
Where is the user documentation? Where is the user documentation?
- ::[User guide](LINK-TO-USER-GUIDE) - ::[User guide](./LINK-TO-USER-GUIDE.md)
- ::[User FAQ](LINK-TO-FAQ) - ::[User FAQ](./LINK-TO-FAQ.md)
#### How can users get technical support or report problems? #### How can users get technical support or report problems?
@ -207,7 +207,7 @@ Where is the user documentation?
_TODO: Define any technical terms that you use above, if a new member of _TODO: Define any technical terms that you use above, if a new member of
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.md) documents._
#### ::TECHNICAL TERM 1 #### ::TECHNICAL TERM 1

26
src/ProductPlan/Target-and-Benefits.md
View File

@ -2,7 +2,7 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -10,9 +10,9 @@
##### Related Documents ##### Related Documents
- [Proposal](Proposal) > Target Audience and Benefits - [Proposal](./Proposal.md) > Target Audience and Benefits
- [Project proposal](Proposal) > [User needs](User-Needs) - [Project proposal](./Proposal.md) > [User needs](./User-Needs.md)
- [Glossary](Glossary) - [Glossary](./Glossary.md)
--- ---
@ -47,20 +47,20 @@ 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](#tbd)\]. ::10,000 users \[[magazine article](./#tbd.md)\].
::$10M, growing annually at 4% \[[industry analyst](#tbd)\]. ::$10M, growing annually at 4% \[[industry analyst](./#tbd.md)\].
#### 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](#tbd) - ::[Competitor 1](./#tbd.md)
- ::[Competitor 2](#tbd) - ::[Competitor 2](./#tbd.md)
- ::[Do-it-yourself solutions](#tbd) - ::[Do-it-yourself solutions](./#tbd.md)
#### Are there any known customers for this product? #### Are there any known customers for this product?
- ::[MegaCorp, corporate I.T. department](#tbd) - ::[MegaCorp, corporate I.T. department](./#tbd.md)
- ::[Worldwide Global Corporation](#tbd) - ::[Worldwide Global Corporation](./#tbd.md)
- ::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
@ -72,10 +72,10 @@ 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.md)._
_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> tag), otherwise use bullet lists (the HTML &lt;ul> tag)._ &lt;ol> tag), otherwise use bullet lists (./the HTML &lt;ul> tag.md)._
- ::Increases play-value - ::Increases play-value
- ::Many players enjoy games more when they play as a team. - ::Many players enjoy games more when they play as a team.

4
src/ProductPlan/Test-Case-Format.md
View File

@ -2,7 +2,7 @@
##### Related Documents ##### Related Documents
- [QA Plan](QA-Plan) > [Test Suite](Test-Suite) > Test Case Format - [QA Plan](./QA-Plan.md) > [Test Suite](./Test-Suite.md) > Test Case Format
--- ---
@ -71,7 +71,7 @@ different users.
::Visit a page or screen. For web applications, LOCATION may be ::Visit a page or screen. For web applications, LOCATION may be
a hyperlink. The location should be a well-known starting point a hyperlink. The location should be a well-known starting point
(e.g., the Login screen), drilling down to specific pages should be (./e.g., the Login screen.md), drilling down to specific pages should be
part of the test. part of the test.
#### ::enter FIELD-NAME \[as VALUE\] \[in SCREEN-LOCATION\] #### ::enter FIELD-NAME \[as VALUE\] \[in SCREEN-LOCATION\]

6
src/ProductPlan/Test-Cases.md
View File

@ -1,7 +1,7 @@
<!-- markdownlint-disable-next-line first-line-h1 --> <!-- markdownlint-disable-next-line first-line-h1 -->
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -9,8 +9,8 @@
##### Related Documents ##### Related Documents
[QA Plan](QA-Plan) > [Test Suite](Test-Suite) > Test Cases [QA Plan](./QA-Plan.md) > [Test Suite](./Test-Suite.md) > Test Cases
[System test case format](Test-Case-Format) [System test case format](./Test-Case-Format.md)
::LINKS TO RELEVANT STANDARDS ::LINKS TO RELEVANT STANDARDS
::LINKS TO OTHER DOCUMENTS ::LINKS TO OTHER DOCUMENTS

42
src/ProductPlan/Test-Run-Suite.md
View File

@ -2,7 +2,7 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -10,8 +10,8 @@
##### Related Documents ##### Related Documents
- [QA Plan](QA-Plan) > Test Run Suite - [QA Plan](./QA-Plan.md) > Test Run Suite
- [Test suite](Test-Suite) - [Test suite](./Test-Suite.md)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -26,14 +26,14 @@ assess risk, and focus ongoing testing efforts.
_TODO:_ _TODO:_
- _Review the [target audience](Target-and-Benefits), - _Review the [target audience](./Target-and-Benefits.md),
[environmental requirements](SRS#environmental), and [possible [environmental requirements](./SRS#environmental.md), and [possible
deployments](Design-Architecture#deployment) to understand the deployments](./Design-Architecture#deployment.md) 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) document._ the [test-runs](./Test-Runs.md) 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._
@ -41,9 +41,9 @@ _TODO:_
| OS \ Browser | IE | Firefox | Safari | Chrome | other | | OS \ Browser | IE | Firefox | Safari | Chrome | other |
| ------------ | --------------------------- | --------------------------- | --------------------------- | --------- | ----- | | ------------ | --------------------------- | --------------------------- | --------------------------- | --------- | ----- |
| ::Windows | ::[Passed](Test-Runs#TR-01) | ::[Passed](Test-Runs#TR-02) | ::N/A | ::Pending | ::N/A | | ::Windows | ::[Passed](./Test-Runs#TR-01.md) | ::[Passed](./Test-Runs#TR-02.md) | ::N/A | ::Pending | ::N/A |
| ::Linux | ::N/A | ::[Passed](Test-Runs#TR-03) | ::Pending | ::Pending | ::N/A | | ::Linux | ::N/A | ::[Passed](./Test-Runs#TR-03.md) | ::Pending | ::Pending | ::N/A |
| ::Mac | ::[FAILED](Test-Runs#TR-10) | ::Pending | ::[Passed](Test-Runs#TR-11) | ::Pending | ::N/A | | ::Mac | ::[FAILED](./Test-Runs#TR-10.md) | ::Pending | ::[Passed](./Test-Runs#TR-11.md) | ::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 |
@ -53,10 +53,10 @@ _TIP: Use this outline to guide the testing of internationalized
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#TR-00) - ::English US: [Passed](./Test-Runs#TR-00.md)
- ::English UK: [Passed](Test-Runs#TR-01) - ::English UK: [Passed](./Test-Runs#TR-01.md)
- ::English CA: [Passed](Test-Runs#TR-02) - ::English CA: [Passed](./Test-Runs#TR-02.md)
- ::Japanese: [Passed](Test-Runs#TR-10) - ::Japanese: [Passed](./Test-Runs#TR-10.md)
- ::Spanish: Pending - ::Spanish: Pending
- ::Russian: Pending - ::Russian: Pending
- ::German: Pending - ::German: Pending
@ -73,12 +73,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#TR-00) - ::ATA drive: [Passed](./Test-Runs#TR-00.md)
- ::SCSI drive: [Passed](Test-Runs#TR-01) - ::SCSI drive: [Passed](./Test-Runs#TR-01.md)
- ::SATA drive: [Passed](Test-Runs#TR-02) - ::SATA drive: [Passed](./Test-Runs#TR-02.md)
- ::USB drive: [FAILED](Test-Runs#TR-03) - ::USB drive: [FAILED](./Test-Runs#TR-03.md)
- ::Macs - ::Macs
- ::EIDE drive: [Passed](Test-Runs#TR-10) - ::EIDE drive: [Passed](./Test-Runs#TR-10.md)
- ::SCSI drive: [Passed](Test-Runs#TR-11) - ::SCSI drive: [Passed](./Test-Runs#TR-11.md)
- ::Firewire drive: Pending - ::Firewire drive: Pending
- ::USB drive: [FAILED](Test-Runs#TR-12) - ::USB drive: [FAILED](./Test-Runs#TR-12.md)

22
src/ProductPlan/Test-Runs.md
View File

@ -1,6 +1,6 @@
<!-- markdownlint-disable-next-line first-line-h1 -->##### Project <!-- markdownlint-disable-next-line first-line-h1 -->##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -8,8 +8,8 @@
##### Related Documents ##### Related Documents
- [QA Plan](QA-Plan) > [Test Run Suite](Test-Run-Suite) > Test Runs - [QA Plan](./QA-Plan.md) > [Test Run Suite](./Test-Run-Suite.md) > Test Runs
- [Test suit](Test-Suite) - [Test suit](./Test-Suite.md)
- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO RELEVANT STANDARDS
- ::LINKS TO OTHER DOCUMENTS - ::LINKS TO OTHER DOCUMENTS
@ -84,7 +84,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.md).
**Test Run Results:** **Test Run Results:**
@ -113,7 +113,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.md).
**Test Run Results:** **Test Run Results:**
@ -142,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.md).
**Test Run Results:** **Test Run Results:**
@ -171,7 +171,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.md).
**Test Run Results:** **Test Run Results:**
@ -200,7 +200,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.md).
**Test Run Results:** **Test Run Results:**
@ -229,7 +229,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.md).
**Test Run Results:** **Test Run Results:**
@ -258,7 +258,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.md).
**Test Run Results:** **Test Run Results:**
@ -287,7 +287,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.md).
**Test Run Results:** **Test Run Results:**

126
src/ProductPlan/Test-Suite.md
View File

@ -3,7 +3,7 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -11,15 +11,15 @@
##### Related Documents ##### Related Documents
- [QA Plan](QA-Plan) > Test Suite - [QA Plan](./QA-Plan.md) > Test Suite
- [Test case format](Test-Case-Format) - [Test case format](./Test-Case-Format.md)
- ::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.md). 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
@ -30,7 +30,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) document. Use them _TIP: Refer back to your [use cases](./Use-Cases.md) 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
@ -51,18 +51,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#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) | | ::Student | <ul><li>::[student-add-1](./Test-Cases#student-add-1.md)</li><li>::[student-add-2](./Test-Cases#student-add-2.md)</li><li>::[student-add-3](./Test-Cases#student-add-3.md)</li></ul> | ::[student-list-1](./Test-Cases#student-list-1.md) | <ul><li>::[student-edit-1](./Test-Cases#student-edit-1.md)</li><li>::[student-edit-2](./Test-Cases#student-edit-2.md)</li></ul> | ::[student-delete-1](./test-casesstudent-delete-1.md) | <ul><li>::[student-search-1](./Test-Cases#student-search-1.md)</li><li>::[student-search-2](./Test-Cases#student-search-2.md)</li></ul> | ::[See grid below](./#enroll-grid.md) |
| ::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 | | ::Course | <ul><li>::[course-add-1](./Test-Cases#course-add-1.md)</li><li>::[course-add-2](./Test-Cases#course-add-2.md)</li></ul> | ::[course-list-1](./Test-Cases#course-list-1.md) | <ul><li>::[course-edit-1](./Test-Cases#course-edit-1.md)</li><li>::[course-move-1](./Test-Cases#course-move-1.md)</li><li>::[course-add-prereq-1](./Test-Cases#course-add-prereq-1.md)</li></ul> | ::[course-cancel-1](./Test-Cases#course-cancel-1.md) | ::[course-search-1](./Test-Cases#course-search-1.md) | ::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 | | ::Room | <ul><li>::[room-add-1](./Test-Cases#room-add-1.md)</li><li>::[room-add-2](./Test-Cases#room-add-2.md)</li></ul> | ::[room-list-1](./Test-Cases#room-list-1.md) | ::TODO | ::TODO | ::TODO | ::N/A |
| ::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> | | ::Instructor | ::[inst-add-1](./Test-Cases#inst-add-1.md) | ::N/A | ::[inst-edit-1](./Test-Cases#inst-edit-1.md) | ::[inst-delete-1](./Test-Cases#inst-delete-1.md) | ::N/A | <ul><li>::[inst-eval-1](./Test-Cases#inst-eval-1.md)</li><li>::[inst-eval-2](./Test-Cases#inst-eval-2.md)</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#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> | | ::In Major | [::enroll-priority-2](./Test-Cases#enroll-priority-2.md) | [::enroll-priority-1](./Test-Cases#enroll-priority-1.md) | [::enroll-priority-1](./Test-Cases#enroll-priority-1.md) | <ul><li>[::enroll-1](./Test-Cases#enroll-1.md)</li><li>[::enroll-2](./Test-Cases#enroll-2.md)</li><li>[::enroll-3](./Test-Cases#enroll-3.md)</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> | | ::Non-Major | [::enroll-priority-2](./Test-Cases#enroll-priority-2.md) | [::enroll-priority-1](./Test-Cases#enroll-priority-1.md) | [::enroll-priority-1](./Test-Cases#enroll-priority-1.md) | <ul><li>[::enroll-1](./Test-Cases#enroll-1.md)</li><li>[::enroll-2](./Test-Cases#enroll-2.md)</li><li>[::enroll-3](./Test-Cases#enroll-3.md)</li></ul> |
| ::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) | | ::Honors Course | [::enroll-priority-1](./Test-Cases#enroll-priority-1.md) | [::enroll-priority-1](./Test-Cases#enroll-priority-1.md) | [::enroll-priority-1](./Test-Cases#enroll-priority-1.md) | [::enroll-restricted-1](./Test-Cases#enroll-restricted-1.md) |
### Test Cases by Feature Priority ### Test Cases by Feature Priority
@ -72,29 +72,29 @@ cases for each feature. If a feature needs more test cases, note that
with "TODO"._ with "TODO"._
- Essential - Essential
- ::[F-01](features#F-01): - ::[F-01](./features#F-01.md):
::[student-add-1](Test-Cases#student-add-1) ::[student-add-1](./Test-Cases#student-add-1.md)
::[student-add-2](Test-Cases#student-add-2) ::[student-add-2](./Test-Cases#student-add-2.md)
::[student-add-3](Test-Cases#student-add-3) ::[student-add-3](./Test-Cases#student-add-3.md)
- ::[F-02](features#F-02): [enroll-1](Test-Cases#enroll-1) - ::[F-02](./features#F-02.md): [enroll-1](./Test-Cases#enroll-1.md)
::[enroll-2](Test-Cases#enroll-2) ::[enroll-2](./Test-Cases#enroll-2.md)
::[enroll-3](Test-Cases#enroll-3) ::[enroll-3](./Test-Cases#enroll-3.md)
::[enroll-priority-1](Test-Cases#enroll-priority-1) ::[enroll-priority-1](./Test-Cases#enroll-priority-1.md)
::[enroll-priority-2](Test-Cases#enroll-priority-2) ::[enroll-priority-2](./Test-Cases#enroll-priority-2.md)
::[enroll-restricted-1](Test-Cases#enroll-restricted-1) ::[enroll-restricted-1](./Test-Cases#enroll-restricted-1.md)
- Expected - Expected
- ::[F-22](features#F-22): - ::[F-22](./features#F-22.md):
::[student-search-1](Test-Cases#student-search-1) ::[student-search-1](./Test-Cases#student-search-1.md)
::[student-search-2](Test-Cases#student-search-2) ::[student-search-2](./Test-Cases#student-search-2.md)
::[course-search-1](Test-Cases#course-search-1) ::[course-search-1](./Test-Cases#course-search-1.md)
- ::[F-23](features#F-23): - ::[F-23](./features#F-23.md):
::[room-add-1](Test-Cases#room-add-1) ::[room-add-1](./Test-Cases#room-add-1.md)
::[room-add-2](Test-Cases#room-add-2) ::[room-add-2](./Test-Cases#room-add-2.md)
::[room-edit-1](Test-Cases#room-edit-1) TODO ::[room-edit-1](./Test-Cases#room-edit-1.md) TODO
- Desired - Desired
- ::[F-31](features#F-31): - ::[F-31](./features#F-31.md):
::[inst-eval-1](Test-Cases#inst-eval-1) ::[inst-eval-1](./Test-Cases#inst-eval-1.md)
::[inst-eval-2](Test-Cases#inst-eval-2) ::[inst-eval-2](./Test-Cases#inst-eval-2.md)
### Test Cases by Use Case Priority ### Test Cases by Use Case Priority
@ -104,35 +104,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.md)
- ::[student-add-1](Test-Cases#student-add-1) - ::[student-add-1](./Test-Cases#student-add-1.md)
- ::[student-add-2](Test-Cases#student-add-2) - ::[student-add-2](./Test-Cases#student-add-2.md)
- ::[student-add-3](Test-Cases#student-add-3) - ::[student-add-3](./Test-Cases#student-add-3.md)
- ::[UC-02](Use-Cases#UC-02) - ::[UC-02](./Use-Cases#UC-02.md)
- ::[enroll-1](Test-Cases#enroll-1) - ::[enroll-1](./Test-Cases#enroll-1.md)
- ::[UC-03](Use-Cases#UC-03) - ::[UC-03](./Use-Cases#UC-03.md)
- ::[enroll-2](Test-Cases#enroll-2) - ::[enroll-2](./Test-Cases#enroll-2.md)
- ::[UC-04](Use-Cases#UC-04) - ::[UC-04](./Use-Cases#UC-04.md)
- ::[enroll-3](Test-Cases#enroll-3) - ::[enroll-3](./Test-Cases#enroll-3.md)
- ::[UC-05](Use-Cases#UC-05) - ::[UC-05](./Use-Cases#UC-05.md)
- ::[enroll-priority-1](Test-Cases#enroll-priority-1) - ::[enroll-priority-1](./Test-Cases#enroll-priority-1.md)
- ::[enroll-priority-2](Test-Cases#enroll-priority-2) - ::[enroll-priority-2](./Test-Cases#enroll-priority-2.md)
- ::[UC-06](Use-Cases#UC-06) - ::[UC-06](./Use-Cases#UC-06.md)
- ::[enroll-restricted-1](Test-Cases#enroll-restricted-1) - ::[enroll-restricted-1](./Test-Cases#enroll-restricted-1.md)
- Expected - Expected
- ::[UC-22](Use-Cases#UC-22): - ::[UC-22](./Use-Cases#UC-22.md):
::[student-search-1](Test-Cases#student-search-1) ::[student-search-1](./Test-Cases#student-search-1.md)
::[student-search-2](Test-Cases#student-search-2) ::[student-search-2](./Test-Cases#student-search-2.md)
- ::[UC-23](Use-Cases#UC-23): - ::[UC-23](./Use-Cases#UC-23.md):
::[course-search-1](Test-Cases#course-search-1) ::[course-search-1](./Test-Cases#course-search-1.md)
- ::[UC-30](Use-Cases#UC-30): - ::[UC-30](./Use-Cases#UC-30.md):
::[room-add-1](Test-Cases#room-add-1) ::[room-add-1](./Test-Cases#room-add-1.md)
::[room-add-2](Test-Cases#room-add-2) ::[room-add-2](./Test-Cases#room-add-2.md)
- ::[UC-31](Use-Cases#UC-31): - ::[UC-31](./Use-Cases#UC-31.md):
::[room-edit-1](Test-Cases#room-edit-1) TODO ::[room-edit-1](./Test-Cases#room-edit-1.md) TODO
- ::[UC-32](Use-Cases#UC-32): TODO - ::[UC-32](./Use-Cases#UC-32.md): TODO
- ::[UC-33](Use-Cases#UC-33): TODO - ::[UC-33](./Use-Cases#UC-33.md): TODO
- Desired - Desired
- ::[UC-40](Use-Cases#UC-40): - ::[UC-40](./Use-Cases#UC-40.md):
::[inst-eval-1](Test-Cases#inst-eval-1) ::[inst-eval-1](./Test-Cases#inst-eval-1.md)
::[inst-eval-2](Test-Cases#inst-eval-2) ::[inst-eval-2](./Test-Cases#inst-eval-2.md)

12
src/ProductPlan/Use-Case-Format.md
View File

@ -1,16 +1,16 @@
<!-- markdownlint-disable-next-line first-line-h1 --> <!-- markdownlint-disable-next-line first-line-h1 -->
##### Related Documents ##### Related Documents
- [SRS](SRS) > [Use Case Suite](Use-Case-Suite) > Use Case Format - [SRS](./SRS.md) > [Use Case Suite](./Use-Case-Suite.md) > 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.md) 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.md)
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.*
@ -32,7 +32,7 @@ file.*
::Project is set up ::Project is set up
*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) document. Only use those fields that your [Use Cases](./Use-Cases.md) 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.*
--- ---
@ -141,5 +141,5 @@ use case.
For more information on advice, see: For more information on advice, see:
- Words of wisdom on [use case suites](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/use-case-suite.html). - Words of wisdom on [use case suites](./https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/use-case-suite.html.md).
- Words of wisdom on [use cases](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/use-cases.html). - Words of wisdom on [use cases](./https://web.archive.org/web/20200701142616/http://readyset.tigris.org/words-of-wisdom/use-cases.html.md).

126
src/ProductPlan/Use-Case-Suite.md
View File

@ -3,7 +3,7 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Internal Release Number ##### Internal Release Number
@ -11,10 +11,10 @@
##### Related Documents ##### Related Documents
- [SRS](SRS) > Use Case Suite - [SRS](./SRS.md) > Use Case Suite
- [Project proposal](Proposal) > [User needs](User-Needs) - [Project proposal](./Proposal.md) > [User needs](./User-Needs.md)
- [SRS](SRS) > [Feature set](Feature-Set) - [SRS](./SRS.md) > [Feature set](./Feature-Set.md)
- [Use case format](Use-Case-Format) - [Use case format](./Use-Case-Format.md)
- ::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
@ -33,7 +33,7 @@ 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.md)
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._
@ -47,95 +47,95 @@ 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.md) Configure the site
- ::[UC-01](Use-Cases#UC-01) Register as a new user - ::[UC-01](./Use-Cases#UC-01.md) Register as a new user
- ::[UC-02](Use-Cases#UC-02) Request new password - ::[UC-02](./Use-Cases#UC-02.md) Request new password
- ::[UC-03](Use-Cases#UC-03) Edit user profile - ::[UC-03](./Use-Cases#UC-03.md) Edit user profile
- ::[UC-04](Use-Cases#UC-04) View user profile - ::[UC-04](./Use-Cases#UC-04.md) View user profile
- ::Course management - ::Course management
- ::[UC-10](Use-Cases#UC-10) Create course - ::[UC-10](./Use-Cases#UC-10.md) Create course
- ::[UC-11](Use-Cases#UC-11) View catalog description - ::[UC-11](./Use-Cases#UC-11.md) View catalog description
- ::[UC-31](Use-Cases#UC-31) Assign course to room - ::[UC-31](./Use-Cases#UC-31.md) Assign course to room
- ::Course enrollment - ::Course enrollment
- ::[UC-20](Use-Cases#UC-20) Enroll in course - ::[UC-20](./Use-Cases#UC-20.md) Enroll in course
- ::[UC-21](Use-Cases#UC-21) Drop course - ::[UC-21](./Use-Cases#UC-21.md) Drop course
- ::Scalability and availability - ::Scalability and availability
- ::N/A: These features are completely automated and internal, users never interact with them - ::N/A: These features are completely automated and internal, users never interact with them
- ::Facilities management - ::Facilities management
- ::[UC-30](Use-Cases#UC-30) View room description - ::[UC-30](./Use-Cases#UC-30.md) View room description
- ::[UC-31](Use-Cases#UC-31) Assign course to room - ::[UC-31](./Use-Cases#UC-31.md) 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.md) NAME OF USE CASE
- ::[UC-71](Use-Cases#UC-71) NAME OF USE CASE - ::[UC-71](./Use-Cases#UC-71.md) 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.md) NAME OF USE CASE
- ::[UC-81](Use-Cases#UC-81) NAME OF USE CASE - ::[UC-81](./Use-Cases#UC-81.md) 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.md) NAME OF USE CASE
- ::[UC-91](Use-Cases#UC-91) NAME OF USE CASE - ::[UC-91](./Use-Cases#UC-91.md) NAME OF USE CASE
### Use Cases by Stakeholder ### Use Cases by Stakeholder
This information is shown in the [use case diagram](LINK-TO-DIAGRAM), This information is shown in the [use case diagram](./LINK-TO-DIAGRAM.md),
but it is shown here as a list or table so that missing use cases are 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.md) View catalog description
- ::[UC-30](Use-Cases#UC-30) View room description - ::[UC-30](./Use-Cases#UC-30.md) View room description
- ::Students - ::Students
- ::[UC-01](Use-Cases#UC-01) Register as a new user - ::[UC-01](./Use-Cases#UC-01.md) Register as a new user
- ::[UC-02](Use-Cases#UC-02) Request new password - ::[UC-02](./Use-Cases#UC-02.md) Request new password
- ::[UC-03](Use-Cases#UC-03) Edit user profile - ::[UC-03](./Use-Cases#UC-03.md) Edit user profile
- ::[UC-20](Use-Cases#UC-20) Enroll in course - ::[UC-20](./Use-Cases#UC-20.md) Enroll in course
- ::[UC-21](Use-Cases#UC-21) Drop course - ::[UC-21](./Use-Cases#UC-21.md) Drop course
- ::Instructors - ::Instructors
- ::[UC-04](Use-Cases#UC-04) View user profile - ::[UC-04](./Use-Cases#UC-04.md) View user profile
- ::Administrators - ::Administrators
- ::[UC-00](Use-Cases#UC-00) Configure the site - ::[UC-00](./Use-Cases#UC-00.md) Configure the site
- ::[UC-10](Use-Cases#UC-10) Create course - ::[UC-10](./Use-Cases#UC-10.md) Create course
- ::[UC-31](Use-Cases#UC-31) Assign course to room - ::[UC-31](./Use-Cases#UC-31.md) 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.md) NAME OF USE CASE
- ::[UC-71](Use-Cases#UC-71) NAME OF USE CASE - ::[UC-71](./Use-Cases#UC-71.md) NAME OF USE CASE
- ::STAKEHOLDER - ::STAKEHOLDER
- ::[UC-80](Use-Cases#UC-80) NAME OF USE CASE - ::[UC-80](./Use-Cases#UC-80.md) NAME OF USE CASE
- ::[UC-81](Use-Cases#UC-81) NAME OF USE CASE - ::[UC-81](./Use-Cases#UC-81.md) NAME OF USE CASE
- ::STAKEHOLDER - ::STAKEHOLDER
- ::[UC-90](Use-Cases#UC-90) NAME OF USE CASE - ::[UC-90](./Use-Cases#UC-90.md) NAME OF USE CASE
- ::[UC-91](Use-Cases#UC-91) NAME OF USE CASE - ::[UC-91](./Use-Cases#UC-91.md) 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.md) Configure the site
- ::[UC-01](Use-Cases#UC-01) Register as a new user - ::[UC-01](./Use-Cases#UC-01.md) Register as a new user
- ::[UC-10](Use-Cases#UC-10) Create course - ::[UC-10](./Use-Cases#UC-10.md) Create course
- ::[UC-11](Use-Cases#UC-11) View catalog description - ::[UC-11](./Use-Cases#UC-11.md) View catalog description
- ::[UC-20](Use-Cases#UC-20) Enroll in course - ::[UC-20](./Use-Cases#UC-20.md) Enroll in course
- ::[UC-21](Use-Cases#UC-21) Drop course - ::[UC-21](./Use-Cases#UC-21.md) Drop course
- ::[UC-30](Use-Cases#UC-30) Assign course to room - ::[UC-30](./Use-Cases#UC-30.md) Assign course to room
- ::[UC-31](Use-Cases#UC-31) Assign course to room - ::[UC-31](./Use-Cases#UC-31.md) Assign course to room
- Expected - Expected
- ::[UC-02](Use-Cases#UC-02) Request new password - ::[UC-02](./Use-Cases#UC-02.md) Request new password
- ::[UC-03](Use-Cases#UC-03) Edit user profile - ::[UC-03](./Use-Cases#UC-03.md) Edit user profile
- ::[UC-04](Use-Cases#UC-04) View user profile - ::[UC-04](./Use-Cases#UC-04.md) View user profile
- ::[UC-70](Use-Cases#UC-70) NAME OF USE CASE - ::[UC-70](./Use-Cases#UC-70.md) NAME OF USE CASE
- ::[UC-71](Use-Cases#UC-71) NAME OF USE CASE - ::[UC-71](./Use-Cases#UC-71.md) NAME OF USE CASE
- ::[UC-80](Use-Cases#UC-80) NAME OF USE CASE - ::[UC-80](./Use-Cases#UC-80.md) NAME OF USE CASE
- ::[UC-81](Use-Cases#UC-81) NAME OF USE CASE - ::[UC-81](./Use-Cases#UC-81.md) 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.md) View room description
- ::[UC-90](Use-Cases#UC-90) NAME OF USE CASE - ::[UC-90](./Use-Cases#UC-90.md) NAME OF USE CASE
- ::[UC-91](Use-Cases#UC-91) NAME OF USE CASE - ::[UC-91](./Use-Cases#UC-91.md) NAME OF USE CASE
### Use Cases by Business Object and Actor ### Use Cases by Business Object and Actor
@ -143,6 +143,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.md)</li><li>::[Request new password](./Use-Cases#uc-02.md)</li><li>::[Edit user profile](./Use-Cases#uc-03.md)</li></ul> | ::[View user profile](./Use-Cases#uc-04.md) | ::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.md) | <ul><li>::[Enroll in course](./Use-Cases#uc-20.md)</li><li>::[Drop course](./Use-Cases#uc-21.md)</li></ul> | ::TODO | <ul><li>::[Create course](./Use-Cases#uc-10.md)</li><li>::[Assign room](./Use-Cases#uc-31.md)</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.md) | ::N/A | ::N/A | ::[Assign room](./Use-Cases#uc-31.md) |

12
src/ProductPlan/Use-Cases.md
View File

@ -10,9 +10,9 @@
##### Related Documents ##### Related Documents
- [SRS](SRS) > [Use Case Suite](Use-Case-Suite) > Use Cases - [SRS](./SRS.md) > [Use Case Suite](./Use-Case-Suite.md) > Use Cases
- [Project proposal](Proposal) > [User needs](User-Needs), [SRS](SRS) > [Feature set](Feature-Set) - [Project proposal](./Proposal.md) > [User needs](./User-Needs.md), [SRS](./SRS.md) > [Feature set](./Feature-Set.md)
- [Use case format](Use-Case-Format) - [Use case format](./Use-Case-Format.md)
- ::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
@ -41,7 +41,7 @@ note it's specific value to replace or add to the default._
::User is logged in ::User is logged in
_TODO: For each use case listed in the [use case _TODO: For each use case listed in the [use case
suite](Use-Case-Suite), create an HTML anchor and heading with it's suite](./Use-Case-Suite.md), create an HTML anchor and heading with it's
unique ID, then fill in the rows of the table to specify the use case in unique ID, then fill in the rows of the table to specify the use case in
detail._ detail._
@ -50,7 +50,7 @@ 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.md)._
--- ---
@ -111,7 +111,7 @@ _TIP: See detailed tips in the
1. ::visit Login page 1. ::visit Login page
2. ::click to register as new user 2. ::click to register as new user
3. ::enter identifying information: username, email, real name, password (twice) 3. ::enter identifying information: username, email, real name, password (./twice.md)
4. ::submit form 4. ::submit form
5. ::check email 5. ::check email
6. ::reply to confirmation message 6. ::reply to confirmation message

6
src/ProductPlan/User-Guide.md
View File

@ -6,7 +6,7 @@ information._
##### Product ##### Product
::[PRODUCT-NAME](http://www.COMPANY.com/products/PRODUCT-NAME/) ::[PRODUCT-NAME](./http://www.COMPANY.com/products/PRODUCT-NAME/.md)
##### Release Number ##### Release Number
@ -19,7 +19,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/.md) or email
us at <support@COMPANY.com> us at <support@COMPANY.com>
--- ---
@ -28,7 +28,7 @@ us at <support@COMPANY.com>
_TODO: Fill in the user guide outline below._ _TODO: Fill in the user guide outline below._
_TIP: Consider providing both tutorial (step-by-step) and reference _TIP: Consider providing both tutorial (./step-by-step.md) and reference
material. You can organize the user guide by features, by use cases, by material. You can organize the user guide by features, by use cases, by
roles, or in other ways._ roles, or in other ways._

42
src/ProductPlan/User-Needs.md
View File

@ -2,24 +2,24 @@
##### Project ##### Project
::[PROJECT-NAME](Home) ::[PROJECT-NAME](./Home.md)
##### Attached worksheets ##### Attached worksheets
- User needs > [Interview notes](interview-notes.html) - User needs > [Interview notes](./interview-notes.html.md)
##### Related Documents ##### Related Documents
- [Project proposal](Proposal) > [Target audience and benefits](Target-and-Benefits) - [Project proposal](./Proposal.md) > [Target audience and benefits](./Target-and-Benefits.md)
- [Software requirements specification](SRS) - [Software requirements specification](./SRS.md)
- [Glossary](Glossary) - [Glossary](./Glossary.md)
--- ---
**Process impact:** The statement of user needs documents and explains **Process impact:** The statement of user needs documents and explains
the actual desires of stakeholders in roughly their own words. What they the actual desires of stakeholders in roughly their own words. What they
_desire_ is never exactly what the product _provides_. Documenting user _desire_ is never exactly what the product _provides_. Documenting user
needs here, independently from the [SRS](SRS), helps to keep the needs here, independently from the [SRS](./SRS.md), helps to keep the
SRS precise and makes the tasks of verification and validation more SRS precise and makes the tasks of verification and validation more
effective. This document is _not_ an informal draft of the SRS, it is effective. This document is _not_ an informal draft of the SRS, it is
different document with a complementary purpose. different document with a complementary purpose.
@ -33,13 +33,13 @@ project goals into a brief statement and try to get the stakeholders to
agree to it. The text below gives three alternative examples, select agree to it. The text below gives three alternative examples, select
one, or write your own._ one, or write your own._
::We were given an [initial project description](LINK) that is agreed to ::We were given an [initial project description](./LINK.md) that is agreed to
by all stakeholders. by all stakeholders.
::After several interviews and brainstorming sessions, we have [revised ::After several interviews and brainstorming sessions, we have [revised
project description](LINK) that has been agreed to by all stakeholders. project description](./LINK.md) that has been agreed to by all stakeholders.
::There are still a few different (but overlapping) visions of what this ::There are still a few different (./but overlapping.md) visions of what this
project needs to achieve. When a single joint vision is agreed to, it project needs to achieve. When a single joint vision is agreed to, it
will be hyper-linked from here. will be hyper-linked from here.
@ -76,7 +76,7 @@ while the user is walking from one section of the warehouse
to another. Lighting is good in that environment, but there are many to another. Lighting is good in that environment, but there are many
noises and distractions. noises and distractions.
#### What is the system's technology environment (hardware and software)? #### What is the system's technology environment (./hardware and software.md)?
:: 60% of game players have machines with P-II or equivalent :: 60% of game players have machines with P-II or equivalent
processors, while 30% have P-I machines, and 10% have less processors, while 30% have P-I machines, and 10% have less
@ -162,30 +162,30 @@ it here._
#### ::DATE, INTERVIEWEE #### ::DATE, INTERVIEWEE
::[interview with INTERVIEWEE](interview-notes.html) ::[interview with INTERVIEWEE](./interview-notes.html.md)
#### ::DATE-1, INTERVIEWEE #### ::DATE-1, INTERVIEWEE
::NOTES FROM INTERVIEW...(pasted here) ::NOTES FROM INTERVIEW...(./pasted here.md)
#### ::DATE-2, INTERVIEWEE #### ::DATE-2, INTERVIEWEE
::NOTES FROM INTERVIEW...(pasted here) ::NOTES FROM INTERVIEW...(./pasted here.md)
#### ::DATE-3, PARTICIPANTS #### ::DATE-3, PARTICIPANTS
::NOTES FROM BRAINSTORMING SESSION...(pasted here) ::NOTES FROM BRAINSTORMING SESSION...(./pasted here.md)
#### ::DATE-4, PARTICIPANTS #### ::DATE-4, PARTICIPANTS
::[email from INTERVIEWEE](LINK-TO-ARCHIVE) ::[email from INTERVIEWEE](./LINK-TO-ARCHIVE.md)
### User Stories ### User Stories
_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.md) 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.md) 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.
Note the source of each user story._ Note the source of each user story._
@ -197,14 +197,14 @@ servers about 8 hours a week for the last 3 weeks. John has chatted
with Bob about strategies and they have enjoyed some duels. Bob is a with Bob about strategies and they have enjoyed some duels. Bob is a
member of the RedDawn clan. That clan plays a tournament on a member of the RedDawn clan. That clan plays a tournament on a
private server Friday nights. Bob invites John to visit the RedDawn private server Friday nights. Bob invites John to visit the RedDawn
website and join. (Source: [INTERVIEWEE](interview-notes.html)) website and join. (./Source: [INTERVIEWEE](interview-notes.html.md))
#### finding-the-tournament #### finding-the-tournament
:: Bob is visiting his friend. He tries to use his friend's computer to :: Bob is visiting his friend. He tries to use his friend's computer to
log onto the RedDawn SuperShooter tournament. But, he does not log onto the RedDawn SuperShooter tournament. But, he does not
remember the exact name of the server. So, he visits the RedDawn remember the exact name of the server. So, he visits the RedDawn
clan website to find that information. (Source: PERSON-NAME) clan website to find that information. (./Source: PERSON-NAME.md)
#### STORY-NAME-1 #### STORY-NAME-1
@ -231,7 +231,7 @@ following system capacity:
50-500 new registrations each day) 50-500 new registrations each day)
- ::1000 users browsing the web site any given time - ::1000 users browsing the web site any given time
- ::1000 gaming clans - ::1000 gaming clans
- ::1000 members of a single clan (average: 8) - ::1000 members of a single clan (./average: 8.md)
- ::4 MB max disk space for each clan (average: 0.5 MB) - ::4 MB max disk space for each clan (./average: 0.5 MB.md)
- ::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

4
src/ProductPlan/Words-of-Wisdom-Architecture.md
View File

@ -20,11 +20,11 @@ Link to UML component diagrams or list the major components of the system.
### How will the components be deployed to processes and machines? ### How will the components be deployed to processes and machines?
Outline each possible type of deployment configuration. Some products will have only one possible deployment, while others will have a few common deployments for large, medium, and small customers, or for internal (development, testing, and staging) or external (production) usage. Outline each possible type of deployment configuration. Some products will have only one possible deployment, while others will have a few common deployments for large, medium, and small customers, or for internal (./development, testing, and staging.md) or external (./production.md) usage.
### What aspects/resources of their environment are shared? ### What aspects/resources of their environment are shared?
List resources that are shared between machines. Shared resources are potential system bottlenecks that limit scalability, and they are also points where one component of the system can potentially interfere with another component (e.g., one component completely fills a shared disk and causes other components to fail). List resources that are shared between machines. Shared resources are potential system bottlenecks that limit scalability, and they are also points where one component of the system can potentially interfere with another component (./e.g., one component completely fills a shared disk and causes other components to fail.md).
### How are requests allocated to redundant or load-balanced servers? ### How are requests allocated to redundant or load-balanced servers?

4
src/ProductPlan/Words-of-Wisdom-Interview-Notes.md
View File

@ -2,11 +2,11 @@
## Line-by-line Instructions ## Line-by-line Instructions
### Interviewer(s) ### Interviewer(./s.md)
List the person or people who conducted the interview. List the person or people who conducted the interview.
### Interviewee(s) ### Interviewee(./s.md)
List the person or people who responded during the interview. List the person or people who responded during the interview.

2
src/ProductPlan/Words-of-Wisdom-Persistence.md
View File

@ -42,7 +42,7 @@ Write a sentence or bullet for each directory that the system uses to store user
Specify the operating system file access controls that will be used. E.g., certain files will be owned by certain operating system users, and each file will be readable, writeable, and/or executable by its owning user, user group, or other users. Specify the operating system file access controls that will be used. E.g., certain files will be owned by certain operating system users, and each file will be readable, writeable, and/or executable by its owning user, user group, or other users.
### What information (if any) will be stored on client machines? For how long? ### What information (./if any.md) will be stored on client machines? For how long?
If you use cookies or client-side caches, describe those here. If you use cookies or client-side caches, describe those here.

2
src/ProductPlan/Words-of-Wisdom-Proposal.md
View File

@ -32,7 +32,7 @@ Explain why a better product would matter to customers or project stakeholders.
### How will this product be better than previous approaches? ### How will this product be better than previous approaches?
Describe how this product will actually be better than the current alternatives. This may be due to better functionality ("defining features" are covered below), or other aspects of the product that make it easier to buy, install, or use. Describe how this product will actually be better than the current alternatives. This may be due to better functionality (./"defining features" are covered below.md), or other aspects of the product that make it easier to buy, install, or use.
### Where is there more information on this problem? ### Where is there more information on this problem?

2
src/ProductPlan/Words-of-Wisdom-Release-Notes.md
View File

@ -4,7 +4,7 @@
### Release Number ### Release Number
This is the external release number (the one that customers see). This is the external release number (./the one that customers see.md).
### Release Date ### Release Date

18
src/ProductPlan/Words-of-Wisdom-SRS.md
View File

@ -16,35 +16,35 @@ Feature specifications are a very important part of the SRS. They are written in
### What are the usability requirements? ### What are the usability requirements?
List any specific usability requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall"). List any specific usability requirements here. Refer to existing standards documents and write new requirements as "shall statements" (./sentences that use the word "shall".md).
### What are the reliability and up-time requirements? ### What are the reliability and up-time requirements?
List any specific reliability and up-time requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall"). List any specific reliability and up-time requirements here. Refer to existing standards documents and write new requirements as "shall statements" (./sentences that use the word "shall".md).
### What are the safety requirements? ### What are the safety requirements?
List any specific safety requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall"). List any specific safety requirements here. Refer to existing standards documents and write new requirements as "shall statements" (./sentences that use the word "shall".md).
### What are the security requirements? ### What are the security requirements?
List any specific security requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall"). List any specific security requirements here. Refer to existing standards documents and write new requirements as "shall statements" (./sentences that use the word "shall".md).
### What are the performance and scalability requirements requirements? ### What are the performance and scalability requirements requirements?
List any specific performance requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall"). List any specific performance requirements here. Refer to existing standards documents and write new requirements as "shall statements" (./sentences that use the word "shall".md).
### What are the maintainability and upgradability requirements? ### What are the maintainability and upgradability requirements?
List any specific maintainability and upgradability requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall"). List any specific maintainability and upgradability requirements here. Refer to existing standards documents and write new requirements as "shall statements" (./sentences that use the word "shall".md).
### What are the supportability and operability requirements? ### What are the supportability and operability requirements?
List any specific supportability and operability requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall"). List any specific supportability and operability requirements here. Refer to existing standards documents and write new requirements as "shall statements" (./sentences that use the word "shall".md).
### What are the business lifecycle requirements? ### What are the business lifecycle requirements?
List any specific business lifecycle requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall"). List any specific business lifecycle requirements here. Refer to existing standards documents and write new requirements as "shall statements" (./sentences that use the word "shall".md).
### What are the system hardware requirements? ### What are the system hardware requirements?
@ -60,4 +60,4 @@ List any specific API requirements here. Refer to existing standards documents.
### What are the data import and export requirements? ### What are the data import and export requirements?
List any specific import and export requirements here. Refer to existing standards documents and write new requirements as "shall statements" (sentences that use the word "shall"). List any specific import and export requirements here. Refer to existing standards documents and write new requirements as "shall statements" (./sentences that use the word "shall".md).

2
src/ProductPlan/Words-of-Wisdom-Target-and-Benefits.md
View File

@ -4,7 +4,7 @@
### What market segment is this product in? ### What market segment is this product in?
Simply name the market segment that this product falls into. If you cannot name the market segment, then you probably do not know enough about the overall market yet. If your product bridges two market segments, list them both. If your product is so novel that it does not fit any existing market segment, name a new market segment using a combination of terms that describe current segments, or choose the market segment that your potential customers will think that your product falls into (until the learn more about it). Simply name the market segment that this product falls into. If you cannot name the market segment, then you probably do not know enough about the overall market yet. If your product bridges two market segments, list them both. If your product is so novel that it does not fit any existing market segment, name a new market segment using a combination of terms that describe current segments, or choose the market segment that your potential customers will think that your product falls into (./until the learn more about it.md).
### What is the target market for this product? ### What is the target market for this product?

2
src/ProductPlan/Words-of-Wisdom-Test-Suite.md
View File

@ -6,7 +6,7 @@
The advantage of this test case organization is that it visualizes the overall set of tests in a way that helps identify missing tests. The advantage of this test case organization is that it visualizes the overall set of tests in a way that helps identify missing tests.
### Detailed Test Case Grid(s) ### Detailed Test Case Grid(./s.md)
Use this sub-grid to visually organize the set of tests that would fit into a single table cell in the main test grid. This level of detail helps to visualize whether all possible situations are covered. I.e., are all relevant classes of input values covered? and are all relevant system states covered? Use this sub-grid to visually organize the set of tests that would fit into a single table cell in the main test grid. This level of detail helps to visualize whether all possible situations are covered. I.e., are all relevant classes of input values covered? and are all relevant system states covered?

2
src/ProductPlan/Words-of-Wisdom-User-Needs-and-Stories.md
View File

@ -14,7 +14,7 @@ A "business environment" is the overall business setting in which the system wil
Describe where the server will be located. And, describe where users will be located. Briefly note the physical characteristics of these environments affect the system's performance or usability. Describe where the server will be located. And, describe where users will be located. Briefly note the physical characteristics of these environments affect the system's performance or usability.
### What is the system's technology environment (hardware and software)? ### What is the system's technology environment (./hardware and software.md)?
Describe the hardware and software that the system depends on, or interoperates with. Note compatability features that users expect. Describe the hardware and software that the system depends on, or interoperates with. Note compatability features that users expect.

68
src/ProductPlan/Words-of-Wisdom.md
View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable-next-line first-line-h1 --> <!-- markdownlint-disable-next-line first-line-h1 -->
The original [ReadySET Pro](http://readysetpro.com) words of wisdom are [here](http://www.readysetpro.com/words-of-wisdom). The original [ReadySET Pro](./http://readysetpro.com.md) words of wisdom are [here](./http://www.readysetpro.com/words-of-wisdom.md).
*** ***
@ -9,63 +9,63 @@ The following pages contain specific tips and advice on each template.
### Project kick-off ### Project kick-off
* [Project proposal](Words-of-Wisdom-Proposal) * [Project proposal](./Words-of-Wisdom-Proposal.md)
* [Target audience & benefits](Words-of-Wisdom-Target-and-Benefits) * [Target audience & benefits](./Words-of-Wisdom-Target-and-Benefits.md)
* [User needs & stories](Words-of-Wisdom-User-Needs-and-Stories) * [User needs & stories](./Words-of-Wisdom-User-Needs-and-Stories.md)
* [Interview notes](Words-of-Wisdom-Interview-Notes) * [Interview notes](./Words-of-Wisdom-Interview-Notes.md)
* [All-in-one project summary](Words-of-Wisdom-All-in-One-Project-Summary) * [All-in-one project summary](./Words-of-Wisdom-All-in-One-Project-Summary.md)
### Project Reference Information ### Project Reference Information
* [Project overview](Words-of-Wisdom-Project-Overview) * [Project overview](./Words-of-Wisdom-Project-Overview.md)
* [Glossary / Data dictionary](Words-of-Wisdom-Glossary-and-Data-Dictionary) * [Glossary / Data dictionary](./Words-of-Wisdom-Glossary-and-Data-Dictionary.md)
* [Software development method](Words-of-Wisdom-Software-Development-Method) * [Software development method](./Words-of-Wisdom-Software-Development-Method.md)
### System requirements ### System requirements
* [SRS](Words-of-Wisdom-SRS) * [SRS](./Words-of-Wisdom-SRS.md)
* [Use case suite](Words-of-Wisdom-Use-Case-Suite) * [Use case suite](./Words-of-Wisdom-Use-Case-Suite.md)
* [Feature set](Words-of-Wisdom-Feature-Set) * [Feature set](./Words-of-Wisdom-Feature-Set.md)
### Planning ### Planning
* [Project plan](Words-of-Wisdom-Project-Plan) * [Project plan](./Words-of-Wisdom-Project-Plan.md)
* [Resource needs](Words-of-Wisdom-Resource-Needs) * [Resource needs](./Words-of-Wisdom-Resource-Needs.md)
* [Risk management](Words-of-Wisdom-Risk-Management) * [Risk management](./Words-of-Wisdom-Risk-Management.md)
* [Legal issues](Words-of-Wisdom-Legal-Issues) * [Legal issues](./Words-of-Wisdom-Legal-Issues.md)
### Design ### Design
* [Design overview](Words-of-Wisdom-Design-Overview) * [Design overview](./Words-of-Wisdom-Design-Overview.md)
* [Architecture](Words-of-Wisdom-Architecture) * [Architecture](./Words-of-Wisdom-Architecture.md)
* [Persistence](Words-of-Wisdom-Persistence) * [Persistence](./Words-of-Wisdom-Persistence.md)
* [User interface](Words-of-Wisdom-User-Interface) * [User interface](./Words-of-Wisdom-User-Interface.md)
* [Security](Words-of-Wisdom-Security) * [Security](./Words-of-Wisdom-Security.md)
* [Source organization](Words-of-Wisdom-Source-Organization) * [Source organization](./Words-of-Wisdom-Source-Organization.md)
### Project tracking ### Project tracking
* [Status report](Words-of-Wisdom-Status-Report) * [Status report](./Words-of-Wisdom-Status-Report.md)
* [Review meeting](Words-of-Wisdom-Review-Meeting) * [Review meeting](./Words-of-Wisdom-Review-Meeting.md)
### Quality management ### Quality management
* [QA plan](Words-of-Wisdom-QA-Plan) * [QA plan](./Words-of-Wisdom-QA-Plan.md)
* [Test suite](Words-of-Wisdom-Test-Suite) * [Test suite](./Words-of-Wisdom-Test-Suite.md)
### Product content ### Product content
* [Release notes](Words-of-Wisdom-Release-Notes) * [Release notes](./Words-of-Wisdom-Release-Notes.md)
* [Installation / Quick-start](Words-of-Wisdom-Installation-and-Quick-Start) * [Installation / Quick-start](./Words-of-Wisdom-Installation-and-Quick-Start.md)
* [User Guide](Words-of-Wisdom-User-Guide) * [User Guide](./Words-of-Wisdom-User-Guide.md)
* [FAQ / Troubleshooting](Words-of-Wisdom-FAQ-and-Troubleshooting) * [FAQ / Troubleshooting](./Words-of-Wisdom-FAQ-and-Troubleshooting.md)
### Product support information ### Product support information
* [Implementation notes](Words-of-Wisdom-Implementation-Notes) * [Implementation notes](./Words-of-Wisdom-Implementation-Notes.md)
* [Demo script](Words-of-Wisdom-Demo-Script) * [Demo script](./Words-of-Wisdom-Demo-Script.md)
### Release end-game ### Release end-game
* [Release checklist](Words-of-Wisdom-Release-Checklist) * [Release checklist](./Words-of-Wisdom-Release-Checklist.md)
* [Postmortem report](Words-of-Wisdom-Postmortem-Report) * [Postmortem report](./Words-of-Wisdom-Postmortem-Report.md)

200
src/ProductPlan/Workflows.md
View File

@ -2,127 +2,127 @@
### By Activity ### By Activity
1. Project Planning 1. Project Planning
1. [Home](Home) 1. [Home](./Home.md)
2. [Proposal](Proposal) 2. [Proposal](./Proposal.md)
- [Target and Benefits](Target-and-Benefits) - [Target and Benefits](./Target-and-Benefits.md)
3. [Project Plan](Project-Plan) 3. [Project Plan](./Project-Plan.md)
- [Resource needs](Resource-Needs) - [Resource needs](./Resource-Needs.md)
4. [Legal Issues](Legal) 4. [Legal Issues](./Legal.md)
5. [QA Plan](QA-Plan) 5. [QA Plan](./QA-Plan.md)
2. Requirements and Specification 2. Requirements and Specification
1. [User Needs](User-Needs) 1. [User Needs](./User-Needs.md)
- [Interview Notes](Interview-Notes) - [Interview Notes](./Interview-Notes.md)
2. [Software Requirements Specification](SRS) 2. [Software Requirements Specification](./SRS.md)
- [Use Case Suite](Use-Case-Suite) - [Use Case Suite](./Use-Case-Suite.md)
- [Feature Set](Feature-Set) - [Feature Set](./Feature-Set.md)
3. Architecture and Design 3. Architecture and Design
1. [Design](Design) 1. [Design](./Design.md)
- [Architecture Worksheet](Design-Architecture) - [Architecture Worksheet](./Design-Architecture.md)
- [Source and Build](Design-Src-Org) - [Source and Build](./Design-Src-Org.md)
- [User Interface Worksheet](Design-UI) - [User Interface Worksheet](./Design-UI.md)
- [Persistence Worksheet](Design-Persistence) - [Persistence Worksheet](./Design-Persistence.md)
- [Security Worksheet](Design-Security) - [Security Worksheet](./Design-Security.md)
4. Implementation and Testing 4. Implementation and Testing
1. [User Guide](User-Guide) 1. [User Guide](./User-Guide.md)
2. [Test Suite](Test-Suite) 2. [Test Suite](./Test-Suite.md)
- [Test Case Format](Test-Case-Format) - [Test Case Format](./Test-Case-Format.md)
- [Test Cases](Test-Cases) - [Test Cases](./Test-Cases.md)
5. Deployment and Installation 5. Deployment and Installation
1. [Release Checklist](Release-Checklist) 1. [Release Checklist](./Release-Checklist.md)
2. [Installation / Quick Start Guide](Installation-Guide) 2. [Installation / Quick Start Guide](./Installation-Guide.md)
3. [Release Notes](Release-Notes) 3. [Release Notes](./Release-Notes.md)
4. [Demo Script](Demo-Script) 4. [Demo Script](./Demo-Script.md)
6. Operations and Support 6. Operations and Support
1. [FAQ / Troubleshooting](FAQ) 1. [FAQ / Troubleshooting](./FAQ.md)
2. [Implementation Notes](Implementation-Notes) 2. [Implementation Notes](./Implementation-Notes.md)
7. Continuous or Final 7. Continuous or Final
1. [Glossary](Glossary) 1. [Glossary](./Glossary.md)
2. [Status Report](Status-Report) 2. [Status Report](./Status-Report.md)
3. [Review Meeting Notes](Review-Meeting-Notes) 3. [Review Meeting Notes](./Review-Meeting-Notes.md)
4. [Software Development Methodology](SDM) 4. [Software Development Methodology](./SDM.md)
### By Suggested Sequence ### By Suggested Sequence
1. Step 1 1. Step 1
1. [Home](Home) 1. [Home](./Home.md)
2. [Proposal](Proposal) 2. [Proposal](./Proposal.md)
- [](Target-and-Benefits)[Target and Benefits](Target-and-Benefits) - [](./Target-and-Benefits.md)[Target and Benefits](./Target-and-Benefits.md)
3. [Project Plan](Project-Plan) 3. [Project Plan](./Project-Plan.md)
- [Resource needs](Resource-Needs) - [Resource needs](./Resource-Needs.md)
4. [Legal Issues](Legal) 4. [Legal Issues](./Legal.md)
5. [Glossary](Glossary) 5. [Glossary](./Glossary.md)
2. Step 2 2. Step 2
1. [User Needs](User-Needs) 1. [User Needs](./User-Needs.md)
- [Interview Notes](Interview-Notes) - [Interview Notes](./Interview-Notes.md)
2. [Software Requirements Specification](SRS) 2. [Software Requirements Specification](./SRS.md)
- [Use Case Suite](Use-Case-Suite) - [Use Case Suite](./Use-Case-Suite.md)
- [Feature Set](Feature-Set) - [Feature Set](./Feature-Set.md)
3. [Software Development Methodology](SDM) 3. [Software Development Methodology](./SDM.md)
3. Step 3 3. Step 3
1. [Design](Design) 1. [Design](./Design.md)
- [Architecture Worksheet](Design-Architecture) - [Architecture Worksheet](./Design-Architecture.md)
- [Source and Build](Design-Src-Org) - [Source and Build](./Design-Src-Org.md)
- [User Interface Worksheet](Design-UI) - [User Interface Worksheet](./Design-UI.md)
- [Persistence Worksheet](Design-Persistence) - [Persistence Worksheet](./Design-Persistence.md)
- [Security Worksheet](Design-Security) - [Security Worksheet](./Design-Security.md)
4. Step 4 4. Step 4
1. [QA Plan](QA-Plan) 1. [QA Plan](./QA-Plan.md)
2. [Test Suite](Test-Suite) 2. [Test Suite](./Test-Suite.md)
- [Test Case Format](Test-Case-Format) - [Test Case Format](./Test-Case-Format.md)
- [Test Cases](Test-Cases) - [Test Cases](./Test-Cases.md)
5. Step 5 5. Step 5
1. [Review Meeting Notes](Review-Meeting-Notes) 1. [Review Meeting Notes](./Review-Meeting-Notes.md)
6. Step 6 6. Step 6
1. [Release Checklist](Release-Checklist) 1. [Release Checklist](./Release-Checklist.md)
7. Step 7 7. Step 7
1. [Installation / Quick Start Guide](Installation-Guide) 1. [Installation / Quick Start Guide](./Installation-Guide.md)
2. [Release Notes](Release-Notes) 2. [Release Notes](./Release-Notes.md)
3. [User Guide](User-Guide) 3. [User Guide](./User-Guide.md)
4. [Demo Script](Demo-Script) 4. [Demo Script](./Demo-Script.md)
5. [FAQ / Troubleshooting](FAQ) 5. [FAQ / Troubleshooting](./FAQ.md)
6. [Implementation Notes](Implementation-Notes) 6. [Implementation Notes](./Implementation-Notes.md)
8. Every week 8. Every week
1. [Status Report](Status-Report) 1. [Status Report](./Status-Report.md)
### All Templates ### All Templates
1. [Summary](Summary) 1. [Summary](./Summary.md)
2. [Home](Home) 2. [Home](./Home.md)
3. [Proposal](Proposal) 3. [Proposal](./Proposal.md)
- [Target and Benefits](Target-and-Benefits) - [Target and Benefits](./Target-and-Benefits.md)
4. [Project Plan](Project-Plan) 4. [Project Plan](./Project-Plan.md)
- [Resource needs](Resource-Needs) - [Resource needs](./Resource-Needs.md)
5. [QA Plan](QA-Plan) 5. [QA Plan](./QA-Plan.md)
- [Test Suite](Test-Suite) - [Test Suite](./Test-Suite.md)
- [Test Case Format](Test-Case-Format) - [Test Case Format](./Test-Case-Format.md)
- [Test Cases](Test-Cases) - [Test Cases](./Test-Cases.md)
- [Review Meeting Notes](Review-Meeting-Notes) - [Review Meeting Notes](./Review-Meeting-Notes.md)
6. [Legal Issues](Legal) 6. [Legal Issues](./Legal.md)
7. [User Needs](User-Needs) 7. [User Needs](./User-Needs.md)
- [Interview Notes](Interview-Notes) - [Interview Notes](./Interview-Notes.md)
8. [Software Requirements Specification](SRS) 8. [Software Requirements Specification](./SRS.md)
- [Use Case Suite](Use-Case-Suite) - [Use Case Suite](./Use-Case-Suite.md)
- [Feature Set](Feature-Set) - [Feature Set](./Feature-Set.md)
9. [Glossary](Glossary) 9. [Glossary](./Glossary.md)
10. [Design](Design) 10. [Design](./Design.md)
- [Architecture Worksheet](Design-Architecture) - [Architecture Worksheet](./Design-Architecture.md)
- [Source and Build](Design-Src-Org) - [Source and Build](./Design-Src-Org.md)
- [User Interface Worksheet](Design-UI) - [User Interface Worksheet](./Design-UI.md)
- [Persistence Worksheet](Design-Persistence) - [Persistence Worksheet](./Design-Persistence.md)
- [Security Worksheet](Design-Security) - [Security Worksheet](./Design-Security.md)
11. [User Guide](User-Guide) 11. [User Guide](./User-Guide.md)
12. [Release Checklist](Release-Checklist) 12. [Release Checklist](./Release-Checklist.md)
13. [Installation / Quick Start Guide](Installation-Guide) 13. [Installation / Quick Start Guide](./Installation-Guide.md)
14. [Release Notes](Release-Notes) 14. [Release Notes](./Release-Notes.md)
15. [Demo Script](Demo-Script) 15. [Demo Script](./Demo-Script.md)
16. [FAQ / Troubleshooting](FAQ) 16. [FAQ / Troubleshooting](./FAQ.md)
17. [Implementation Notes](Implementation-Notes) 17. [Implementation Notes](./Implementation-Notes.md)
18. [Status Report](Status-Report) 18. [Status Report](./Status-Report.md)
19. [Software Development Methodology](SDM) 19. [Software Development Methodology](./SDM.md)
### How to download these templates ### How to download these templates
- [Download template archive](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/servlets/ProjectDocumentList), or - [Download template archive](./https://web.archive.org/web/20200701142616/http://readyset.tigris.org/servlets/ProjectDocumentList.md), or
- Use CVS to [check out](https://web.archive.org/web/20200701142616/http://readyset.tigris.org/servlets/ProjectSource) project - Use CVS to [check out](./https://web.archive.org/web/20200701142616/http://readyset.tigris.org/servlets/ProjectSource.md) 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.md)
on Github. on Github.

6
src/ProductPlan/_Footer.md
View File

@ -1,8 +1,8 @@
<!-- markdownlint-disable-next-line first-line-h1 --> <!-- markdownlint-disable-next-line first-line-h1 -->
**TODO:** Check for [words of wisdom](Words-of-Wisdom) for additional advice on this template. **TODO:** Check for [words of wisdom](./Words-of-Wisdom.md) for additional advice on this template.
::**Your-Organization Proprietary** ::**Your-Organization Proprietary**
Copyright 2003-2004 Jason Robbins. All rights reserved. [License terms](LICENSE). Retain this copyright statement whenever this file is used as a template. Copyright 2003-2004 Jason Robbins. All rights reserved. [License terms](./LICENSE.md). Retain this copyright statement whenever this file is used as a template.
Find [Readyset GFM](https://github.com/bike-bill/readyset-gfm) on Github. Find [Readyset GFM](./https://github.com/bike-bill/readyset-gfm.md) on Github.

10
src/ProductPlan/_Sidebar.md
View File

@ -1,6 +1,6 @@
<!-- markdownlint-disable-next-line first-line-h1 --> <!-- markdownlint-disable-next-line first-line-h1 -->
- [Home](Home) - [Home](./Home.md)
- [Summary](Summary) - [Summary](./Summary.md)
- [Project Plan](Project-Plan) - [Project Plan](./Project-Plan.md)
- [Workflows](Workflows) - [Workflows](./Workflows.md)
- [Words of Wisdom](Words-of-Wisdom) - [Words of Wisdom](./Words-of-Wisdom.md)

2
src/SUMMARY.md
View File

@ -17,6 +17,8 @@
# Wardely Value Chain Map # Wardely Value Chain Map
- [Wardley Value Chain](./WardleyValueMap/ValueChain.md)
# Strategic Context # Strategic Context
- [Overview](./StrategicContext/QuestionList.md) - [Overview](./StrategicContext/QuestionList.md)