GFM changes
This commit is contained in:
parent
6387d954be
commit
23485e2888
@ -187,4 +187,4 @@ competition for resources.
|
||||
|
||||
::Yes, everyone understands. Feedback is welcome.
|
||||
|
||||
::No, this is a risk that is noted in the [Risk Management](Project-Plan#risks) section.
|
||||
::No, this is a risk that is noted in the [Risk Management](Project-Plan#Risk-Management) section.
|
||||
|
@ -184,5 +184,5 @@ kept indefinitely.
|
||||
|
||||
::Yes, everyone understands. Feedback is welcome.
|
||||
|
||||
::No, this is a risk that is noted in the [Risk Management](Project-Plan#risks)
|
||||
::No, this is a risk that is noted in the [Risk Management](Project-Plan#Risk-Management)
|
||||
section.
|
||||
|
@ -47,4 +47,4 @@ How well do these mechanisms support the achievement of your goals?
|
||||
::Yes, everyone understands. Feedback is welcome.
|
||||
|
||||
::No, this is a risk that is noted in the
|
||||
[Risk Management](Project-Plan#risks) section.
|
||||
[Risk Management](Project-Plan#Risk-Management) section.
|
||||
|
@ -151,4 +151,4 @@ features. Some example text is provided. Add or delete text as needed.*
|
||||
|
||||
::Yes, everyone understands. Feedback is welcome.
|
||||
|
||||
::No, this is a risk that is noted in the [Risk Management](Project-Plan#risks) section.
|
||||
::No, this is a risk that is noted in the [Risk Management](Project-Plan#Risk-Management) section.
|
||||
|
@ -120,4 +120,4 @@ aimed at specific platforms.
|
||||
|
||||
::Yes, everyone understands. Feedback is welcome.
|
||||
|
||||
::No, this is a risk that is noted in the [Risk Management](Project-Plan#risks) section.
|
||||
::No, this is a risk that is noted in the [Risk Management](Project-Plan#Risk-Management) section.
|
||||
|
@ -131,4 +131,4 @@ revised.*
|
||||
#### Has the design been communicated to the development team and other stakeholders?
|
||||
- ::Yes, everyone understands. Feedback is welcome.
|
||||
- ::No, this is a risk that is noted in the
|
||||
[Risk Management](Project-Plan#risks) section.
|
||||
[Risk Management](Project-Plan#Risk-Management) section.
|
||||
|
97
Glossary.md
97
Glossary.md
@ -1,97 +0,0 @@
|
||||
**Process impact:** This file as a dictionary of terms defined as they
|
||||
are used during the project. Writing out the definitions of terms and
|
||||
acronyms here helps keep other documents more concise and precise. A
|
||||
shared glossary helps prevent misunderstandings and makes it easier for
|
||||
new team members to be productive.
|
||||
|
||||
Jump to: [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) |
|
||||
[G](#g) | [H](#g) | [I](#i) | [J](#j) | [K](#k) | [L](#l) | [M](#m) |
|
||||
[N](#n) | [O](#o) | [P](#p) | [Q](#q) | [R](#r) | [S](#s) | [T](#t) |
|
||||
[U](#u) | [V](#v) | [W](#w) | [X](#x) | [Y](#y) | [Z](#z) |
|
||||
[Standard terms](Glossary-Standard-Terms)
|
||||
|
||||
### Project-specific Terms
|
||||
|
||||
*TIPs:*
|
||||
|
||||
- *Define HTML anchors on your terms with id="TERMNAME" so that other
|
||||
documents can link to the definition of specific terms.*
|
||||
- *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
|
||||
that here too. If something is best defined by using a hyperlink to
|
||||
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,
|
||||
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
|
||||
[bug](Glossary-Standard-Terms#bug).*
|
||||
- *Define only project-specific terms, or ones that a new team member
|
||||
would not know. Don't define standard textbook terms that can be
|
||||
easily found elsewhere.*
|
||||
- *This glossary can serve as simple domain model or data dictionary.
|
||||
You can define important data objects by describing their meaning
|
||||
and key attributes. For example, see [student](#student) and
|
||||
[GPA](#gpa).*
|
||||
|
||||
#### A
|
||||
|
||||
#### B
|
||||
|
||||
#### C
|
||||
|
||||
##### ::Class standing
|
||||
|
||||
- ::Computed attribute of [student](#student) based on number of
|
||||
academic units completed. Used to determine priority in
|
||||
course enrollment.
|
||||
- ::Real-world meaning of values:
|
||||
|
||||
| | |
|
||||
|-------------|---------------------------------|
|
||||
| ::Freshman | ::Less than 90 units |
|
||||
| ::Sophomore | ::Between 90 and 180 units |
|
||||
| ::Junior | ::Between 180 and 270 units |
|
||||
| ::Senior | ::More than 270 units completed |
|
||||
|
||||
#### D
|
||||
|
||||
#### G
|
||||
|
||||
##### ::GEF
|
||||
::*n.* The [Graph Editing Framework](http://gef.tigris.org/). An open
|
||||
source library for editing diagrams (boxes and arrows).
|
||||
|
||||
##### ::GPA
|
||||
::*n.* Grade Point Average. GPA is a float between 0.00 and 4.00,
|
||||
accurate to 2 decimal places. Computed from average of completed
|
||||
course grades in transcript weighted by course units. Used to
|
||||
determine student ranking, and to trigger Dean's List and
|
||||
academic probation.
|
||||
|
||||
#### I
|
||||
|
||||
##### ::ICS
|
||||
::*n.* Acronym for the [School of Information and Computer
|
||||
Science](http://www.ics.uci.edu/) at [UC Irvine](http://www.uci.edu/).
|
||||
|
||||
#### S
|
||||
|
||||
##### ::Student
|
||||
::*n.* A person who attends a school to earn a degree. Persistent
|
||||
attributes include: student\_id\_number (primary key), GPA, major,
|
||||
and years\_at\_school.
|
||||
|
||||
##### ::Senior
|
||||
::*n.* A senior is special type of [undergraduate](#undergraduate) who
|
||||
has a certain number of course credits on his or her transcript.
|
||||
Years\_at\_school does not determine senior standing. TODO: how many
|
||||
credits needed?
|
||||
|
||||
#### T
|
||||
|
||||
##### ::Term3
|
||||
::Definition3
|
||||
|
||||
#### U
|
||||
|
||||
##### ::Undergraduate
|
||||
::A type of [student](#student). *TODO: add more detail.*
|
4
Home.md
4
Home.md
@ -37,7 +37,7 @@ functionality and a wider set of testers.
|
||||
| Reference: | [Glossary](Glossary), [Software Development Methodology](SDM), [Document Cross Reference](Document-Cross-Ref), [All-in-one project summary](Summary) |
|
||||
| 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) |
|
||||
| Construction: | [Review Meeting Notes](Review-Meeting-Notes), [Implementation Notes](Implementation-Notes), [User Guide](User-Guide), [FAQ / Troubleshooting Guide](FAQ) |
|
||||
| Transition: | [Install / Quick Start](Install), [Demo Script](Demo-Script), [Release notes](Release-Notes), [Release checklist](Release-Checklist), [Post Mortem](Post-Mortem) |
|
||||
| Transition: | [Install / Quick Start](Installation-Guide), [Demo Script](Demo-Script), [Release notes](Release-Notes), [Release checklist](Release-Checklist), [Post Mortem](Post-Mortem) |
|
||||
| Continuous: | [Status Report](Status-Report) |
|
||||
|
||||
|By Audience |Documents |
|
||||
@ -46,6 +46,6 @@ functionality and a wider set of testers.
|
||||
| For Management: | [Project Resource Needs](Resource-Needs), [Status Report](Status-Report) |
|
||||
| For Developers: | [Design](Design), [Review Meeting Notes](Review-Meeting-Notes), [Software Development Methodology](SDM) |
|
||||
| For QA: | [QA Plan](QA-Plan) |
|
||||
| For End Users: | [Install / Quick start](Install), [User Guide](User-Guide), [Release Notes](Release-Notes) |
|
||||
| For End Users: | [Install / Quick start](Installation-Guide), [User Guide](User-Guide), [Release Notes](Release-Notes) |
|
||||
| For Support and Ops:| [Implementation Notes](Implementation-Notes), [FAQ / Troubleshooting Guide](FAQ) |
|
||||
| For Sales/Legal: | [Demo Script](Demo-Script), [Legal Issues](Legal) |
|
||||
|
@ -133,10 +133,10 @@ automatically run by the operating system.*
|
||||
engineers when the system is being run in an ASP production environment.*
|
||||
|
||||
#### Install
|
||||
::See the [installation guide](install)
|
||||
::See the [installation guide](Installation-Guide)
|
||||
|
||||
#### Upgrade
|
||||
::See the [installation guide](install)
|
||||
::See the [installation guide](Installation-Guide)
|
||||
|
||||
#### Start Server
|
||||
1. ::STEP 1
|
||||
|
133
Install.md
133
Install.md
@ -1,133 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<link type="image/png" href="assets/logo.png" rel="icon">
|
||||
<title>ReadySet Markdown</title>
|
||||
</head>
|
||||
<script src="https://www.w3schools.com/lib/w3data.js"></script>
|
||||
<body>
|
||||
|
||||
<topbar style="display:none;">
|
||||
<item><a href="index.html">Overview</a></item>
|
||||
<item><a href="plan.html">Project Plan</a></item>
|
||||
<item><a href="index-all.html">Workflows</a></item>
|
||||
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
|
||||
<toc></toc>
|
||||
</topbar>
|
||||
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# Installation / Quick Start Guide
|
||||
---
|
||||
|
||||
*TODO: Fill in information about this product. Make sure to use the
|
||||
**product** name and **external** release number, not internal
|
||||
information.*
|
||||
|
||||
##### Product:
|
||||
::PRODUCT-NAME
|
||||
|
||||
##### Release Number:
|
||||
::X.Y.Z
|
||||
|
||||
##### Release Date:
|
||||
::YEAR/MONTH/DAY
|
||||
|
||||
##### Customer Support:
|
||||
:: For more information or support, please visit our
|
||||
[website](http://www.COMPANY.com/products/PRODUCTNAME/) or
|
||||
email us at <support@COMPANY.com>
|
||||
|
||||
---
|
||||
|
||||
### Introduction
|
||||
|
||||
::This document describes how to install and get started with
|
||||
PRODUCT-NAME.
|
||||
|
||||
### Minimal System Requirements
|
||||
|
||||
::System requirements are described in the [release notes](Release-Notes).
|
||||
|
||||
### Installation
|
||||
|
||||
*TODO: Give detailed installation instructions. Make sure to test these
|
||||
instructions by doing them yourself on a target machine.*
|
||||
|
||||
*TIP: For development releases, or products that are reusable components
|
||||
rather than end-user applications, you should include information on
|
||||
needed development and bugging tools, e.g., Ant and JUnit.*
|
||||
|
||||
#### What other software must be installed first?
|
||||
::Before you can install this product, you must install the following
|
||||
packages:
|
||||
|
||||
- ::[Java SDK](http://java.sun.com/)
|
||||
- ::[Apache Tomcat](http://jakarta.apache.org/)
|
||||
- ::[MySQL database](http://mysql.com/)
|
||||
- ::[OTHER PACKAGES](http://)
|
||||
|
||||
#### How do I install PRODUCT-NAME?
|
||||
:: Please follow these steps
|
||||
|
||||
1. ::STEP
|
||||
2. ::STEP
|
||||
- ::SUB-STEP
|
||||
3. ::STEP
|
||||
4. ::STEP
|
||||
|
||||
#### How can I uninstall PRODUCT-NAME?
|
||||
|
||||
1. ::STEP
|
||||
2. ::STEP
|
||||
- ::SUB-STEP
|
||||
3. ::STEP
|
||||
4. ::STEP
|
||||
|
||||
#### What if I encounter problems?
|
||||
::Please see the troubleshooting section in the [FAQ](FAQ).
|
||||
|
||||
### Getting Started
|
||||
|
||||
*TODO: Briefly describe how the user would accomplish one or two of the
|
||||
main use cases for new users. For development releases or reusable
|
||||
components, include instructions on running unit tests.*
|
||||
|
||||
#### How can I run post-install unit tests?
|
||||
|
||||
1. :Compile the source code by typing "ant"
|
||||
2. :Run unit tests by typing "ant test"
|
||||
- ::A brief report will be shown on the console
|
||||
- ::A detailed test report for any failed tests will be
|
||||
in build/testout.
|
||||
|
||||
#### ::How can I quickly get started using PRODUCT-NAME?
|
||||
|
||||
1. ::STEP
|
||||
2. ::STEP
|
||||
- ::SUB-STEP
|
||||
3. ::STEP
|
||||
4. ::STEP
|
||||
|
||||
<!-- End Markdown content -->
|
||||
</xmp>
|
||||
|
||||
<div w3-include-html="_words-of-wisdom.html"></div>
|
||||
<div w3-include-html="_footer.html"></div>
|
||||
|
||||
<script>
|
||||
w3IncludeHTML();
|
||||
</script>
|
||||
|
||||
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
|
||||
<!-- Include it AFTER strapdown -->
|
||||
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
|
||||
<!-- Include it AFTER EVERYTHING -->
|
||||
<script src="assets/logo.js"></script>
|
||||
<script src="assets/themeswitcher.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
@ -1,27 +1,3 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<link type="image/png" href="assets/logo.png" rel="icon">
|
||||
<title>ReadySet Markdown</title>
|
||||
</head>
|
||||
<script src="https://www.w3schools.com/lib/w3data.js"></script>
|
||||
<body>
|
||||
|
||||
<topbar style="display:none;">
|
||||
<item><a href="index.html">Overview</a></item>
|
||||
<item><a href="plan.html">Project Plan</a></item>
|
||||
<item><a href="index-all.html">Workflows</a></item>
|
||||
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
|
||||
<toc></toc>
|
||||
</topbar>
|
||||
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# Interview Checklist
|
||||
---
|
||||
|
||||
##### Related documents:
|
||||
- [User Needs](User-Needs)
|
||||
- [Interview Notes](interview-notes.html)
|
||||
@ -123,25 +99,3 @@ interviews.
|
||||
users manual, but I did find a magazine review of it." Or,
|
||||
"After I interviewed you, I spoke with Bob, and he confirmed
|
||||
that some current products do cost $0.00."
|
||||
|
||||
<!-- End Markdown content -->
|
||||
</xmp>
|
||||
|
||||
<div w3-include-html="_words-of-wisdom.html"></div>
|
||||
<div w3-include-html="_footer.html"></div>
|
||||
|
||||
<script>
|
||||
w3IncludeHTML();
|
||||
</script>
|
||||
|
||||
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
|
||||
<!-- Include it AFTER strapdown -->
|
||||
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
|
||||
<!-- Include it AFTER EVERYTHING -->
|
||||
<script src="assets/logo.js"></script>
|
||||
<script src="assets/themeswitcher.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
|
@ -1,27 +1,3 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<link type="image/png" href="assets/logo.png" rel="icon">
|
||||
<title>ReadySet Markdown</title>
|
||||
</head>
|
||||
<script src="https://www.w3schools.com/lib/w3data.js"></script>
|
||||
<body>
|
||||
|
||||
<topbar style="display:none;">
|
||||
<item><a href="index.html">Overview</a></item>
|
||||
<item><a href="plan.html">Project Plan</a></item>
|
||||
<item><a href="index-all.html">Workflows</a></item>
|
||||
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
|
||||
<toc></toc>
|
||||
</topbar>
|
||||
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [User Needs](User-Needs) > Interview Notes
|
||||
---
|
||||
|
||||
##### Project:
|
||||
::[PROJECTNAME](Home)
|
||||
|
||||
@ -39,7 +15,7 @@
|
||||
|
||||
##### Related Documents:
|
||||
- [Project proposal](Proposal) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [Interview checklist](interview-checklist.html)
|
||||
- [Interview checklist](Interview-Checklist)
|
||||
- [Glossary](Glossary)
|
||||
---
|
||||
|
||||
@ -91,8 +67,8 @@ Note these new questions and what you must do to find the answer.*
|
||||
- ::Can we do X?
|
||||
- ::Do we support Y?
|
||||
- ::Action item: research topic Z
|
||||
- ::Action item: Send follow-up email as per [post-interview
|
||||
checklist](interview-checklist)
|
||||
- ::Action item: Send follow-up email as per
|
||||
[post-interview checklist](Interview-Checklist#post-interview-checklist)
|
||||
- ::Action item: prepare for next interview with PERSON(S) on DATE
|
||||
|
||||
### Other Interview Notes
|
||||
@ -106,24 +82,3 @@ provided to you by the interviewee.*
|
||||
- ::NOTE
|
||||
- ::NOTE
|
||||
- ::NOTE
|
||||
|
||||
<!-- End Markdown content -->
|
||||
</xmp>
|
||||
|
||||
<div w3-include-html="_words-of-wisdom.html"></div>
|
||||
<div w3-include-html="_footer.html"></div>
|
||||
|
||||
<script>
|
||||
w3IncludeHTML();
|
||||
</script>
|
||||
|
||||
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
|
||||
<!-- Include it AFTER strapdown -->
|
||||
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
|
||||
<!-- Include it AFTER EVERYTHING -->
|
||||
<script src="assets/logo.js"></script>
|
||||
<script src="assets/themeswitcher.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
48
Legal.md
48
Legal.md
@ -1,27 +1,3 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<link type="image/png" href="assets/logo.png" rel="icon">
|
||||
<title>ReadySet Markdown</title>
|
||||
</head>
|
||||
<script src="https://www.w3schools.com/lib/w3data.js"></script>
|
||||
<body>
|
||||
|
||||
<topbar style="display:none;">
|
||||
<item><a href="index.html">Overview</a></item>
|
||||
<item><a href="plan.html">Project Plan</a></item>
|
||||
<item><a href="index-all.html">Workflows</a></item>
|
||||
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
|
||||
<toc></toc>
|
||||
</topbar>
|
||||
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# Legal Issues
|
||||
---
|
||||
|
||||
##### Project:
|
||||
::[PROJECTNAME](Home)
|
||||
|
||||
@ -39,7 +15,7 @@
|
||||
|
||||
##### Related Documents:
|
||||
- [Project proposal](Proposal) > [Target audience and benefits](Target-and-Benefits)
|
||||
- [Plan](plan) > [Resource needs](Resource-Needs)
|
||||
- [Project Plan](Project-Plan) > [Resource needs](Resource-Needs)
|
||||
- [Glossary](Glossary)
|
||||
---
|
||||
|
||||
@ -141,25 +117,3 @@ as needed.*
|
||||
::No. Describe steps to bring the product into compliance.
|
||||
|
||||
::No. No policies apply.
|
||||
|
||||
|
||||
<!-- End Markdown content -->
|
||||
</xmp>
|
||||
|
||||
<div w3-include-html="_words-of-wisdom.html"></div>
|
||||
<div w3-include-html="_footer.html"></div>
|
||||
|
||||
<script>
|
||||
w3IncludeHTML();
|
||||
</script>
|
||||
|
||||
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
|
||||
<!-- Include it AFTER strapdown -->
|
||||
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
|
||||
<!-- Include it AFTER EVERYTHING -->
|
||||
<script src="assets/logo.js"></script>
|
||||
<script src="assets/themeswitcher.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
@ -97,7 +97,7 @@ For more information see the [Software Development Methodology](SDM).
|
||||
|
||||
::This project plan will be updated as needed throughout the project.
|
||||
It will be placed under version control and instructions for
|
||||
accessing it will be on the [project website](index.html). Any
|
||||
accessing it will be on the [project website](Home). Any
|
||||
change to the plan will cause an automatic notification to be sent
|
||||
to a project mailing list.
|
||||
|
||||
@ -171,7 +171,7 @@ engineering time that the team will spend on that task that week. Total
|
||||
your hours across and down.*
|
||||
|
||||
*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) document. And, the
|
||||
hours for each type of effort resources needed should correspond to the
|
||||
sum for each type of task.*
|
||||
|
||||
@ -194,9 +194,9 @@ sum for each type of task.*
|
||||
*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
|
||||
mitigate the risk, state that. Use the risk list below, or the [risks
|
||||
worksheet](risks.html).*
|
||||
worksheet](Risks).*
|
||||
|
||||
Please see the [risks worksheet](risks.html).
|
||||
Please see the [risks worksheet](Risks).
|
||||
|
||||
#### The main risks of this project are
|
||||
|
||||
|
26
Proposal.md
26
Proposal.md
@ -1,26 +1,3 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<link type="image/png" href="assets/logo.png" rel="icon">
|
||||
<title>ReadySet Markdown</title>
|
||||
</head>
|
||||
<script src="https://www.w3schools.com/lib/w3data.js"></script>
|
||||
<body>
|
||||
|
||||
<topbar style="display:none;">
|
||||
<item><a href="index.html">Overview</a></item>
|
||||
<item><a href="plan.html">Project Plan</a></item>
|
||||
<item><a href="index-all.html">Workflows</a></item>
|
||||
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
|
||||
<toc></toc>
|
||||
</topbar>
|
||||
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# Project Proposal
|
||||
---
|
||||
##### Project:
|
||||
::[PROJECTNAME](Home)
|
||||
|
||||
@ -233,4 +210,5 @@ over time.
|
||||
|
||||
### Project Plan
|
||||
|
||||
See attached draft of [project plan](Project-Plan) and [resource needs](Resource-Needs).
|
||||
See attached draft of [project plan](Project-Plan) and
|
||||
[resource needs](Resource-Needs).
|
||||
|
111
QA-Plan.md
111
QA-Plan.md
@ -1,27 +1,3 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<link type="image/png" href="assets/logo.png" rel="icon">
|
||||
<title>ReadySet Markdown</title>
|
||||
</head>
|
||||
<script src="https://www.w3schools.com/lib/w3data.js"></script>
|
||||
<body>
|
||||
|
||||
<topbar style="display:none;">
|
||||
<item><a href="index.html">Overview</a></item>
|
||||
<item><a href="plan.html">Project Plan</a></item>
|
||||
<item><a href="index-all.html">Workflows</a></item>
|
||||
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
|
||||
<toc></toc>
|
||||
</topbar>
|
||||
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# QA Plan
|
||||
---
|
||||
|
||||
*TODO: For each release, update this file by filling in answers to the
|
||||
questions. In cases where multiple answers are already written, delete
|
||||
those answers that do not apply.*
|
||||
@ -39,9 +15,9 @@ those answers that do not apply.*
|
||||
- ::Early access release (Controlled external access)
|
||||
|
||||
##### Attached Worksheets:
|
||||
- QA plan > [Review meeting notes](review-meeting-notes.html)
|
||||
- QA plan > [System test case suite](test-suite.html)
|
||||
- QA plan > [System test runs](test-run-suite.html)
|
||||
- QA plan > [Review meeting notes](Review-Meeting-Notes)
|
||||
- QA plan > [System test case suite](Test-Suite)
|
||||
- QA plan > [System test runs](Test-Run-Suite)
|
||||
|
||||
##### Related Documents:
|
||||
- [Software Requirements Specification](SRS)
|
||||
@ -80,7 +56,7 @@ coordinate all the QA activities.
|
||||
quotation marks and less-than signs) were entered and processed
|
||||
properly, but not displayed properly. From now on, we must test
|
||||
both validation and display of special characters.
|
||||
- ::Large datasets can sometimes make our system fail if the space
|
||||
- ::Large data sets can sometimes make our system fail if the space
|
||||
used for temporary data is used up. Our test plans should
|
||||
include more data volume tests.
|
||||
|
||||
@ -106,7 +82,7 @@ correctness and robustness. We will do that with the following major
|
||||
activities:
|
||||
|
||||
- ::using if-statements to test preconditions and assert statements
|
||||
to test invariants and postconditions
|
||||
to test invariants and post-conditions
|
||||
- ::conducting frequent reviews
|
||||
- ::performing automated unit and regression testing with JUnit
|
||||
- ::carrying out structured manual system testing
|
||||
@ -118,33 +94,33 @@ activities:
|
||||
that make sense for your project on this particular release.*
|
||||
|
||||
- ::Essential
|
||||
- [Functionality > Correctness](Glossary-Standard-Terms#functionality_gt_correctness)
|
||||
- [Functionality > Robustness](Glossary-Standard-Terms#functionality_gt_robustness)
|
||||
- [Functionality > Correctness](Glossary-Standard-Terms#functionality--correctness)
|
||||
- [Functionality > Robustness](Glossary-Standard-Terms#functionality--robustness)
|
||||
- ::Expected
|
||||
- [Functionality > Accuracy](Glossary-Standard-Terms#functionality_gt_accuracy)
|
||||
- [Functionality > Compatibility](Glossary-Standard-Terms#functionality_gt_compatibility)
|
||||
- [Functionality > Factual correctness](Glossary-Standard-Terms#functionality_gt_factual_correctness)
|
||||
- [Usability > Understandability and Readability](Glossary-Standard-Terms#usability_gt_understandability_and_readability)
|
||||
- [Usability > Learnability and Memorability](Glossary-Standard-Terms#usability_gt_learnability_and_memorability)
|
||||
- [Usability > Task support](Glossary-Standard-Terms#usability_gt_task_support)
|
||||
- [Usability > Efficiency](Glossary-Standard-Terms#usability_gt_efficiency)
|
||||
- [Usability > Safety](Glossary-Standard-Terms#usability_gt_safety)
|
||||
- [Usability > Consistency and Familiarity](Glossary-Standard-Terms#usability_gt_consistency_and_familiarity)
|
||||
- [Usability > Subjective satisfaction](Glossary-Standard-Terms#usability_gt_subjective_satisfaction)
|
||||
- [Functionality > Accuracy](Glossary-Standard-Terms#functionality--accuracy)
|
||||
- [Functionality > Compatibility](Glossary-Standard-Terms#functionality--compatibility)
|
||||
- [Functionality > Factual correctness](Glossary-Standard-Terms#functionality--factual-correctness)
|
||||
- [Usability > Understandability and Readability](Glossary-Standard-Terms#usability--understandability-and-readability)
|
||||
- [Usability > Learnability and Memorability](Glossary-Standard-Terms#usability--learnability-and-memorability)
|
||||
- [Usability > Task support](Glossary-Standard-Terms#usability--task-support)
|
||||
- [Usability > Efficiency](Glossary-Standard-Terms#usability--efficiency)
|
||||
- [Usability > Safety](Glossary-Standard-Terms#usability--safety)
|
||||
- [Usability > Consistency and Familiarity](Glossary-Standard-Terms#usability--consistency-and-familiarity)
|
||||
- [Usability > Subjective satisfaction](Glossary-Standard-Terms#usability--subjective-satisfaction)
|
||||
- [Security](Glossary-Standard-Terms#security)
|
||||
- ::Desired
|
||||
- [Reliability > Consistency under load](Glossary-Standard-Terms#reliability_gt_consistency_under_load)
|
||||
- [Reliability > Consistency under concurrency](Glossary-Standard-Terms#reliability_gt_consistency_under_concurrency)
|
||||
- [Reliability > Availability under load](Glossary-Standard-Terms#reliability_gt_availability_under_load)
|
||||
- [Reliability > Longevity](Glossary-Standard-Terms#reliability_gt_longevity)
|
||||
- [Reliability > Consistency under load](Glossary-Standard-Terms#reliability--consistency-under-load)
|
||||
- [Reliability > Consistency under concurrency](Glossary-Standard-Terms#reliability--consistency-under-concurrency)
|
||||
- [Reliability > Availability under load](Glossary-Standard-Terms#reliability--availability-under-load)
|
||||
- [Reliability > Longevity](Glossary-Standard-Terms#reliability--longevity)
|
||||
- [Efficiency](Glossary-Standard-Terms#efficiency)
|
||||
- [Scalability](Glossary-Standard-Terms#scalability)
|
||||
- [Scalability > Performance under load](Glossary-Standard-Terms#scalability_gt_performance_under_load)
|
||||
- [Scalability > Large data volume](Glossary-Standard-Terms#scalability_gt_large_data_volume)
|
||||
- [Scalability > Performance under load](Glossary-Standard-Terms#scalability--performance-under-load)
|
||||
- [Scalability > Large data volume](Glossary-Standard-Terms#scalability--large-data-volume)
|
||||
- [Operability](Glossary-Standard-Terms#operability)
|
||||
- [Maintainability > Understandability](Glossary-Standard-Terms#maintainability_gt_understandability)
|
||||
- [Maintainability > Evolvability](Glossary-Standard-Terms#maintainability_gt_evolvability)
|
||||
- [Maintainability > Testability](Glossary-Standard-Terms#maintainability_gt_testability)
|
||||
- [Maintainability > Understandability](Glossary-Standard-Terms#maintainability--understandability)
|
||||
- [Maintainability > Evolvability](Glossary-Standard-Terms#maintainability--evolvability)
|
||||
- [Maintainability > Testability](Glossary-Standard-Terms#maintainability--testability)
|
||||
|
||||
### QA Strategy
|
||||
|
||||
@ -239,7 +215,7 @@ and tracked to completion.*
|
||||
- ::Each week, identify reviewers and schedule review meetings
|
||||
- ::Reviewers study the material individually for 2 hours
|
||||
- ::Reviewers meet to inspect the material for 2 hours
|
||||
- ::Place [review meeting notes](review-meeting-notes.html) in the
|
||||
- ::Place [review meeting notes](Review-Meeting-Notes) in the
|
||||
repository and track any issues identified in review meetings
|
||||
|
||||
3. Unit tests
|
||||
@ -256,7 +232,7 @@ and tracked to completion.*
|
||||
- ::Update unit tests whenever requirements change
|
||||
|
||||
4. System tests
|
||||
- ::Design and specify a detailed manual [test suite](test-suite.html).
|
||||
- ::Design and specify a detailed manual [test suite](Test-Suite).
|
||||
- ::Review the system test suite to make sure that every UI screen
|
||||
and element is covered
|
||||
- ::Execute system tests completely on each release candidate. These
|
||||
@ -274,7 +250,7 @@ and tracked to completion.*
|
||||
issue tracker is available to all project members
|
||||
[here](LINK-TO-ISSUE-TRACKER). The meaning of issue states,
|
||||
priorities, and other attributes are defined in the
|
||||
[SDM](sdm.html#issuetracking).
|
||||
[SDM](SDM#issue-tracking).
|
||||
|
||||
### QA-Plan Checklist
|
||||
|
||||
@ -285,8 +261,8 @@ and tracked to completion.*
|
||||
this plan as needed.
|
||||
|
||||
::No, this plan leaves open several quality risks that have been noted
|
||||
in the [Risk Management](Project-Plan#risks) section of the [Project
|
||||
Plan](plan).
|
||||
in the [Risk Management](Project-Plan#Risk-Management) section of the
|
||||
[Project Plan](Project-Plan).
|
||||
|
||||
#### Have human resources been allocated to carry out the QA activities?
|
||||
|
||||
@ -318,26 +294,5 @@ is welcome.
|
||||
|
||||
::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
|
||||
[Risk Management](Project-Plan#risks) section of the [Project Plan](Project-Plan).
|
||||
|
||||
|
||||
<!-- End Markdown content -->
|
||||
</xmp>
|
||||
|
||||
<div w3-include-html="_words-of-wisdom.html"></div>
|
||||
<div w3-include-html="_footer.html"></div>
|
||||
|
||||
<script>
|
||||
w3IncludeHTML();
|
||||
</script>
|
||||
|
||||
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
|
||||
<!-- Include it AFTER strapdown -->
|
||||
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
|
||||
<!-- Include it AFTER EVERYTHING -->
|
||||
<script src="assets/logo.js"></script>
|
||||
<script src="assets/themeswitcher.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
[Risk Management](Project-Plan#Risk-Management) section of the
|
||||
[Project Plan](Project-Plan).
|
||||
|
@ -1,6 +1,3 @@
|
||||
7## ReadySET: Overview
|
||||
---
|
||||
|
||||
### Mission
|
||||
- [Browse templates](https://github.com/bike-bill/readyset-markdown)
|
||||
- [Download markdown templates](https://github.com/bike-bill/readyset-markdown)
|
||||
|
16
README.md
16
README.md
@ -1,16 +0,0 @@
|
||||
# ReadySET Strapdown
|
||||
This is a conversion of the [Tigris.org](http://www.tigris.org/) distribution of the ReadySET Software Engineering Templates into [Strapdown.js](http://strapdown.com) format. There is a GitHub mirror of the HTML formatted templates at [@brianbaquiran/readyset](https://github.com/brianbaquiran/readyset). The original ReadySET project is located [here](http://readyset.tigris.org/). There has been no visible development on the original project since [version 0.9.3](http://readyset.tigris.org/docs/release-notes-0-9-3.html) in 2004, but I find it useful, especially in Strapdown/markdown format.
|
||||
|
||||
You can see the original HTML templates [here](http://readyset.tigris.org/nonav/templates/frameset.html).
|
||||
|
||||
# ReadySET
|
||||
Ready-to-use Software Engineering Templates
|
||||
### License
|
||||
ReadySET is released under a [BSD License](http://opensource.org/licenses/bsd-license.php)
|
||||
|
||||
### Handy Strapdown plugin
|
||||
[strapdown-topbar](http://joedf.github.io/strapdown-topbar) allows you to change the order of the top menu.
|
||||
|
||||
### Strapdown themes
|
||||
[Bootswatch](http://bootswatch.com/)
|
||||
http://bootswatch.com/
|
@ -1,26 +1,3 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<link type="image/png" href="assets/logo.png" rel="icon">
|
||||
<title>ReadySet Markdown</title>
|
||||
</head>
|
||||
<script src="https://www.w3schools.com/lib/w3data.js"></script>
|
||||
<body>
|
||||
|
||||
<topbar style="display:none;">
|
||||
<item><a href="index.html">Overview</a></item>
|
||||
<item><a href="plan.html">Project Plan</a></item>
|
||||
<item><a href="index-all.html">Workflows</a></item>
|
||||
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
|
||||
<toc></toc>
|
||||
</topbar>
|
||||
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# ReadySET Licensing Information
|
||||
---
|
||||
|
||||
Do not modify or delete this file. This file describes the license under
|
||||
which you may use the ReadySET templates.
|
||||
@ -92,8 +69,8 @@ same license.
|
||||
|
||||
No, but it would be very welcome. Even if you don't modify the
|
||||
templates, you can share your "words of wisdom". For more
|
||||
information on contributing, see the [ReadySET home
|
||||
page](http://readyset.tigris.org/).
|
||||
information on contributing, see the
|
||||
[ReadySET home page](http://readyset.tigris.org/).
|
||||
|
||||
#### ReadySET seems too good to be true. What is the catch? Why would anyone buy a commercial version?
|
||||
|
||||
@ -101,23 +78,3 @@ 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
|
||||
with ReadySET, but [ReadySET Pro](http://www.readysetpro.com/) holds
|
||||
much more value for corporate users.
|
||||
|
||||
<!-- End Markdown content -->
|
||||
</xmp>
|
||||
|
||||
<!-- <div w3-include-html="_words-of-wisdom.html"></div> -->
|
||||
<!-- <div w3-include-html="_footer.html"></div> -->
|
||||
|
||||
<script>
|
||||
w3IncludeHTML();
|
||||
</script>
|
||||
|
||||
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
|
||||
<!-- Include it AFTER strapdown -->
|
||||
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
|
||||
<!-- Include it AFTER EVERYTHING -->
|
||||
<script src="assets/logo.js"></script>
|
||||
<script src="assets/themeswitcher.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
@ -1,27 +1,3 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<link type="image/png" href="assets/logo.png" rel="icon">
|
||||
<title>ReadySet Markdown</title>
|
||||
</head>
|
||||
<script src="https://www.w3schools.com/lib/w3data.js"></script>
|
||||
<body>
|
||||
|
||||
<topbar style="display:none;">
|
||||
<item><a href="index.html">Overview</a></item>
|
||||
<item><a href="plan.html">Project Plan</a></item>
|
||||
<item><a href="index-all.html">Workflows</a></item>
|
||||
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
|
||||
<toc></toc>
|
||||
</topbar>
|
||||
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# Release Checklist
|
||||
---
|
||||
|
||||
*TODO: For each release, copy this file and fill in answers to the
|
||||
questions. In cases where multiple answers are already written, delete
|
||||
those answers that do not apply.*
|
||||
@ -36,7 +12,6 @@ those answers that do not apply.*
|
||||
::X.Y.Z
|
||||
|
||||
##### Release audience:
|
||||
|
||||
- ::General availability release
|
||||
- ::Customer-specific release: CUSTOMER(S)
|
||||
- ::Developer release (Internal usage only)
|
||||
@ -151,25 +126,3 @@ your organization: Other engineering groups (i.e., hardware design),
|
||||
Manufacturing and Shipping, Software Process Improvement, Key customers
|
||||
and partners, External developers, Risk Management, Business
|
||||
Development, and Upper Management.*
|
||||
|
||||
<!-- End Markdown content -->
|
||||
</xmp>
|
||||
|
||||
<div w3-include-html="_words-of-wisdom.html"></div>
|
||||
<div w3-include-html="_footer.html"></div>
|
||||
|
||||
<script>
|
||||
w3IncludeHTML();
|
||||
</script>
|
||||
|
||||
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
|
||||
<!-- Include it AFTER strapdown -->
|
||||
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
|
||||
<!-- Include it AFTER EVERYTHING -->
|
||||
<script src="assets/logo.js"></script>
|
||||
<script src="assets/themeswitcher.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
|
@ -1,27 +1,3 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<link type="image/png" href="assets/logo.png" rel="icon">
|
||||
<title>ReadySet Markdown</title>
|
||||
</head>
|
||||
<script src="https://www.w3schools.com/lib/w3data.js"></script>
|
||||
<body>
|
||||
|
||||
<topbar style="display:none;">
|
||||
<item><a href="index.html">Overview</a></item>
|
||||
<item><a href="plan.html">Project Plan</a></item>
|
||||
<item><a href="index-all.html">Workflows</a></item>
|
||||
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
|
||||
<toc></toc>
|
||||
</topbar>
|
||||
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# ::PRODUCTNAME X.Y.Z: Release Notes
|
||||
---
|
||||
|
||||
*TODO: For each release, copy this file and fill in the needed
|
||||
information.*
|
||||
|
||||
@ -107,7 +83,7 @@ information can be helpful.*
|
||||
|
||||
#### ::Installation
|
||||
|
||||
::See the [installation instructions](install.html) for full details.
|
||||
::See the [installation instructions](Installation-Guide) for full details.
|
||||
Please note that in this release, ...
|
||||
|
||||
::IMPORTANT: You must completely uninstall any previous "developer
|
||||
@ -191,24 +167,3 @@ Otherwise, same as above.*
|
||||
detailed instructions.
|
||||
- ::DEFECT [10589](#) Static heard while booting
|
||||
- ::DEFECT [10944](#) Repeat-mode cannot play more than 999 times
|
||||
|
||||
<!-- End Markdown content -->
|
||||
</xmp>
|
||||
|
||||
<div w3-include-html="_words-of-wisdom.html"></div>
|
||||
<div w3-include-html="_footer.html"></div>
|
||||
|
||||
<script>
|
||||
w3IncludeHTML();
|
||||
</script>
|
||||
|
||||
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
|
||||
<!-- Include it AFTER strapdown -->
|
||||
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
|
||||
<!-- Include it AFTER EVERYTHING -->
|
||||
<script src="assets/logo.js"></script>
|
||||
<script src="assets/themeswitcher.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
@ -1,8 +1,3 @@
|
||||
|
||||
|
||||
# [Plan](Project-Plan) > Resource Needs
|
||||
---
|
||||
|
||||
##### Project:
|
||||
::[PROJECTNAME](Home)
|
||||
|
||||
@ -89,7 +84,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.
|
||||
|
||||
*TODO: Answer the questions below. If multiple sample answers are
|
||||
provided, [chip away](Glossary-Standard-Terms#chipaway){.def} the ones that do
|
||||
provided, [chip away](Glossary-Standard-Terms#chipping-away) the ones that do
|
||||
not apply. Edit any provided answers as needed. Use this exercise to
|
||||
help you fill in the tables above.*
|
||||
|
||||
@ -295,4 +290,4 @@ help you fill in the tables above.*
|
||||
:: Yes, everyone understands. Feedback is welcome.
|
||||
|
||||
:: No, this is a risk that is noted in the [Risk
|
||||
Management](Project-Plan#risks) section.
|
||||
Management](Project-Plan#Risk-Management) section.
|
||||
|
198
Status-Report.md
198
Status-Report.md
@ -1,198 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<link type="image/png" href="assets/logo.png" rel="icon">
|
||||
<title>ReadySet Markdown</title>
|
||||
</head>
|
||||
<script src="https://www.w3schools.com/lib/w3data.js"></script>
|
||||
<body>
|
||||
|
||||
<topbar style="display:none;">
|
||||
<item><a href="index.html">Overview</a></item>
|
||||
<item><a href="plan.html">Project Plan</a></item>
|
||||
<item><a href="index-all.html">Workflows</a></item>
|
||||
<menu name="Themes"><item><a id="settheme"><b>Current</b></a></item></menu>
|
||||
<toc></toc>
|
||||
</topbar>
|
||||
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# Status Report
|
||||
---
|
||||
|
||||
*TODO: Copy this file for each status report. Fill in the information
|
||||
below. Email a notification to stakeholders when this report is made
|
||||
available.*
|
||||
|
||||
*TODO: Edit the rows in the following table. In some rows, multiple
|
||||
examples are given, you should select/edit only one.*
|
||||
|
||||
##### Project:
|
||||
::[PROJECTNAME](Home)
|
||||
|
||||
##### Status Report Date:
|
||||
::YEAR/MONTH/DAY
|
||||
|
||||
##### Next Internal Release Number:
|
||||
::X.Y.Z
|
||||
|
||||
##### Release Date:
|
||||
- ::Original estimate: YEAR/MONTH/DAY
|
||||
- ::Current estimate: YEAR/MONTH/DAY
|
||||
- ::Change Since Last Report: No change
|
||||
- ::Change Since Last Report: Slipped 2 days
|
||||
- ::Change Since Last Report: Saved 4 days
|
||||
|
||||
##### Open Issues (needing development):
|
||||
- ::[17 defects](ISSUE-TRACKER-QUERY)
|
||||
- ::[8 enhancements]()
|
||||
|
||||
##### Resolved Issues (pending verification):
|
||||
- ::[0 defects]()
|
||||
- ::[2 enhancements]()
|
||||
|
||||
##### Closed Issues:
|
||||
- ::[34 defects]()
|
||||
- ::[3 enhancements]()
|
||||
|
||||
##### Resources used this period:
|
||||
- ::PERSONNAME: 18 hours.
|
||||
- ::PERSONNAME: 15 hours.
|
||||
- ::PERSONNAME: 10 hours.
|
||||
- ::PERSONNAME: 12 hours.
|
||||
|
||||
##### Status Summary:
|
||||
- ::Project completed. This is the final status report.
|
||||
- ::Low risk. Project on track.
|
||||
- ::Medium risk. Problems are being dealt with.
|
||||
- ::High risk. Advice from management and stakeholders needed.
|
||||
- ::Project canceled. This is the final status report.
|
||||
|
||||
##### Related Documents:
|
||||
- [Project plan](Project-Plan) > [Resource needs](Resource-Needs)
|
||||
- [QA plan](qa-plan.html)
|
||||
- [Glossary](Glossary)
|
||||
---
|
||||
|
||||
**Process impact:** This helps keep stakeholders informed of project
|
||||
status so that they may correctly set expectations. Reasoned
|
||||
explanations of slight changes in schedule are much better than major
|
||||
unexplained slips.
|
||||
|
||||
### Detailed Status
|
||||
|
||||
TODO: Provide 1-4 paragraphs describing what has happened on this
|
||||
project. The text below is just an example, replace it with your own
|
||||
words.
|
||||
|
||||
::This week we focused on...
|
||||
|
||||
::Two major problems have been uncovered...
|
||||
|
||||
::We are approximately 30% of the way through the project plan, and
|
||||
running about 2 days ahead of schedule...
|
||||
|
||||
::The reason for the change in estimated release date is...
|
||||
|
||||
::To stay on schedule, we have slipped enhancements [issue92](ISSUE-TRACKER-URL),
|
||||
[issue 101](ISSUE-TRACKER-URL), and [issue 129](ISSUE-TRACKER-URL) to a later
|
||||
release. These issues were selected because ...
|
||||
|
||||
### Risk Management
|
||||
|
||||
*TODO: List 3-10 of the top project risks that are still outstanding.
|
||||
This list may be an **updated** copy from [plan](Project-Plan#risks)
|
||||
or a previous status report.*
|
||||
|
||||
- ::We could face major difficulties with the technology chosen for
|
||||
this project. HOW TO AVOID/MITIGATE?
|
||||
- ::We could have low quality that demands significant rework. HOW TO
|
||||
AVOID/MITIGATE?
|
||||
- ::We could incorrectly assess our progress until it is too late
|
||||
to react. HOW TO AVOID/MITIGATE?
|
||||
- ::There may be a mis-alignment of stakeholder goals or expectations.
|
||||
HOW TO AVOID/MITIGATE?
|
||||
|
||||
### Upcoming Activity
|
||||
|
||||
*TODO: Provide a few bullets describing what you will do between now and
|
||||
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
|
||||
possible.*
|
||||
|
||||
- ::Fix [issue 130](ISSUE-TRACKER-URL)
|
||||
- ::Fix [issue 133](ISSUE-TRACKER-URL)
|
||||
- ::Verify [issue 102](ISSUE-TRACKER-URL), [issue 103](ISSUE-TRACKER-URL),
|
||||
[issue 107](ISSUE-TRACKER-URL), and [issue 109](ISSUE-TRACKER-URL)
|
||||
- ::Conduct regular team meeting: Tuesday, 1 hour
|
||||
- ::Conduct review meeting: Wednesday, 2 hours
|
||||
- ::Make major progress on COMPONENT
|
||||
- ::Work through next release checklist
|
||||
- ::Continue functional testing
|
||||
- ::Revise our integration procedure
|
||||
- ::Release version X.Y.Z
|
||||
|
||||
### Tracking to Plan
|
||||
|
||||
*TODO: Copy the Work Breakdown Structure from the [project plan](Project-Plan) and paste it here.
|
||||
Add a new column for actual effort spent so far by all team members.*
|
||||
|
||||
| Step | Description | Planned Hours | Spent To-Date |
|
||||
|------------|----------------------------------------------------------------------|---------------|---------------|
|
||||
| ::1. | ::Preparation | | |
|
||||
| ::1.1. | ::Developer training | ::30h | ::0h |
|
||||
| ::2. | ::Inception | | |
|
||||
| ::2.1. | ::Requirements gathering | ::30h | ::0h |
|
||||
| ::2.2. | ::Requirements specification | ::20h | ::0h |
|
||||
| ::2.3. | ::Requirements validation | ::10h | ::0h |
|
||||
| ::3. | ::Elaboration | | |
|
||||
| ::3.1. | ::High-level design | ::5h |::0h |
|
||||
| ::3.2. | ::Low-level design (break down by component) | | |
|
||||
| ::3.2.A. | ::Object design | ::10h | ::0h |
|
||||
| ::3.2.B. | ::User interface design | ::10h | ::0h |
|
||||
| ::3.2.C. | ::Database design | ::3h | ::0h |
|
||||
| ::3.3. | ::Design review and evaluation | ::5h | ::0h |
|
||||
| ::4. | ::Construction | | |
|
||||
| ::4.1.A. | ::System implementation | | |
|
||||
| ::4.1.A.1. | ::Implement Component 1 | ::25h | ::0h |
|
||||
| ::4.1.A.2. | ::Implement Component 2 | ::25h | ::0h |
|
||||
| ::4.1.A.3. | ::Implement Component 3 | ::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.B. | ::Technical documentation (break down by component) | ::10h | ::0h |
|
||||
| ::4.1.C. | ::User documentation (break down by component) | ::10h | ::0h |
|
||||
| ::4.1.D. | ::Testing | | |
|
||||
| ::4.1.D.1. | ::Test planning | ::10h | ::0h |
|
||||
| ::4.1.D.2. | ::Test code implementation (break down by component) | ::30h | ::0h |
|
||||
| ::4.1.D.3. | ::Test execution | ::10h | ::0h |
|
||||
| ::4.2. | ::Implementation review and evaluation | ::15h | ::0h |
|
||||
| ::5. | ::Transition | | |
|
||||
| ::5.A. | ::Release packaging | ::3h | ::0h |
|
||||
| 5.B. | ::Documentation for other groups | ::3h | ::0h |
|
||||
| ::6. | ::Reflection | | |
|
||||
| ::6.1. | ::Postmortem report | ::10h | ::0h |
|
||||
| | Total | ::329 hours | |
|
||||
|
||||
<!-- End Markdown content -->
|
||||
</xmp>
|
||||
|
||||
<div w3-include-html="_words-of-wisdom.html"></div>
|
||||
<div w3-include-html="_footer.html"></div>
|
||||
|
||||
<script>
|
||||
w3IncludeHTML();
|
||||
</script>
|
||||
|
||||
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
|
||||
<!-- Include it AFTER strapdown -->
|
||||
<script src="assets/strapdown/strapdown-topbar.min.js"></script>
|
||||
<!-- Include it AFTER EVERYTHING -->
|
||||
<script src="assets/logo.js"></script>
|
||||
<script src="assets/themeswitcher.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [QA Plan](qa-plan.html) > [Test Suite](test-suite.html) > Test Case Format
|
||||
# [QA Plan](qa-plan.html) > [Test Suite](Test-Suite) > Test Case Format
|
||||
---
|
||||
|
||||
**Process impact:** This reference page documents the format of test
|
||||
|
@ -29,7 +29,7 @@
|
||||
::X.Y.Z
|
||||
|
||||
##### Related Documents:
|
||||
- [Test suite](test-suite.html)
|
||||
- [Test suite](Test-Suite)
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
- ::LINKS TO OTHER DOCUMENTS
|
||||
---
|
||||
|
@ -19,7 +19,7 @@
|
||||
<xmp theme="readable" style="display:none;">
|
||||
<!-- Markdown content here -->
|
||||
|
||||
# [QA Plan](qa-plan.html) > [Test Run Suite](test-run-suite.html) > Test Runs
|
||||
# [QA Plan](qa-plan.html) > [Test Run Suite](Test-Run-Suite) > Test Runs
|
||||
---
|
||||
|
||||
##### Project:
|
||||
@ -29,7 +29,7 @@
|
||||
::X.Y.Z
|
||||
|
||||
##### Related Documents:
|
||||
- [Test suit](test-suite.html)
|
||||
- [Test suit](Test-Suite)
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
- ::LINKS TO OTHER DOCUMENTS
|
||||
---
|
||||
|
153
Workflows.md
153
Workflows.md
@ -2,118 +2,119 @@
|
||||
1. Project Planning
|
||||
1. [Home](Home)
|
||||
2. [Proposal](Proposal)
|
||||
- [Target and benefits](Target-and-Benefits)
|
||||
3. [Project plan](Project-Plan)
|
||||
- [Target and Benefits](Target-and-Benefits)
|
||||
3. [Project Plan](Project-Plan)
|
||||
- [Resource needs](Resource-Needs)
|
||||
4. [Legal issues](legal.html)
|
||||
5. [QA Plan](qa-plan.html)
|
||||
4. [Legal Issues](Legal)
|
||||
5. [QA Plan](QA-Plan)
|
||||
2. Requirements and Specification
|
||||
1. [User needs](User-Needs)
|
||||
- [Interview notes](interview-notes.html)
|
||||
1. [User Needs](User-Needs)
|
||||
- [Interview Notes](Interview-Notes)
|
||||
2. [Software Requirements Specification](SRS)
|
||||
- [Use case suite](Use-Case-Suite)
|
||||
- [Feature set](Feature-Set)
|
||||
- [Use Case Suite](Use-Case-Suite)
|
||||
- [Feature Set](Feature-Set)
|
||||
3. Architecture and Design
|
||||
1. [Design](Design)
|
||||
- [Architecture worksheet](Design-Architecture)
|
||||
- [Source and build] > (Design-Src-Org)
|
||||
- [User interface worksheet](Design-UI)
|
||||
- [Persistence worksheet](Design-Persistence)
|
||||
- [Security worksheet](Design-Security)
|
||||
- [Architecture Worksheet](Design-Architecture)
|
||||
- [Source and Build](Design-Src-Org)
|
||||
- [User Interface Worksheet](Design-UI)
|
||||
- [Persistence Worksheet](Design-Persistence)
|
||||
- [Security Worksheet](Design-Security)
|
||||
4. Implementation and Testing
|
||||
1. [User guide](userguide.html)
|
||||
2. [Test suite](test-suite.html)
|
||||
- [Test case format](test-case-format.html)
|
||||
- [Test cases](test-cases.html)
|
||||
1. [User Guide](User-Guide)
|
||||
2. [Test Suite](Test-Suite)
|
||||
- [Test Case Format](Test-Case-Format)
|
||||
- [Test Cases](Test-Cases)
|
||||
5. Deployment and Installation
|
||||
1. [Release checklist](release-checklist.html)
|
||||
2. [Installation / Quick start guide](install.html)
|
||||
3. [Release notes](Release-Notes)
|
||||
4. [Demo script](demo-script.html)
|
||||
1. [Release Checklist](Release-Checklist)
|
||||
2. [Installation / Quick Start Guide](Installation-Guide)
|
||||
3. [Release Notes](Release-Notes)
|
||||
4. [Demo Script](Demo-Script)
|
||||
6. Operations and Support
|
||||
1. [FAQ / Troubleshooting](FAQ)
|
||||
2. [Implementation notes](implementation-notes.html)
|
||||
2. [Implementation Notes](Implementation-Notes)
|
||||
7. Continuous or Final
|
||||
1. [Glossary](Glossary)
|
||||
2. [Status report](status-report.html)
|
||||
3. [Review meeting notes](review-meeting-notes.html)
|
||||
4. [Software development methodology](SDM)
|
||||
2. [Status Report](Status-Report)
|
||||
3. [Review Meeting Notes](Review-Meeting-Notes)
|
||||
4. [Software Development Methodology](SDM)
|
||||
|
||||
### By Suggested Sequence
|
||||
1. Step 1
|
||||
1. [Home](Home)
|
||||
2. [Proposal](Proposal)
|
||||
- [](Target-and-Benefits)[Target and benefits](Target-and-Benefits)
|
||||
3. [Project plan](Project-Plan)
|
||||
- [](Target-and-Benefits)[Target and Benefits](Target-and-Benefits)
|
||||
3. [Project Plan](Project-Plan)
|
||||
- [Resource needs](Resource-Needs)
|
||||
4. [Legal issues](legal.html)
|
||||
4. [Legal Issues](Legal)
|
||||
5. [Glossary](Glossary)
|
||||
2. Step 2
|
||||
1. [User needs](User-Needs)
|
||||
- [Interview notes](interview-notes.html)
|
||||
1. [User Needs](User-Needs)
|
||||
- [Interview Notes](Interview-Notes)
|
||||
2. [Software Requirements Specification](SRS)
|
||||
- [Use case suite](Use-Case-Suite)
|
||||
- [Feature set](Feature-Set)
|
||||
- [Use Case Suite](Use-Case-Suite)
|
||||
- [Feature Set](Feature-Set)
|
||||
3. [Software Development Methodology](SDM)
|
||||
3. Step 3
|
||||
1. [Design](Design)
|
||||
- [Architecture worksheet](Design-Architecture)
|
||||
- [Source and build] > (Design-Src-Org)
|
||||
- [User interface worksheet](Design-UI)
|
||||
- [Persistence worksheet](Design-Persistence)
|
||||
- [Security worksheet](Design-Security)
|
||||
- [Architecture Worksheet](Design-Architecture)
|
||||
- [Source and Build](Design-Src-Org)
|
||||
- [User Interface Worksheet](Design-UI)
|
||||
- [Persistence Worksheet](Design-Persistence)
|
||||
- [Security Worksheet](Design-Security)
|
||||
4. Step 4
|
||||
1. [QA Plan](qa-plan.html)
|
||||
2. [Test suite](test-suite.html)
|
||||
- [Test case format](test-case-format.html)
|
||||
- [Test cases](test-cases.html)
|
||||
1. [QA Plan](QA-Plan)
|
||||
2. [Test Suite](Test-Suite)
|
||||
- [Test Case Format](Test-Case-Format)
|
||||
- [Test Cases](Test-Cases)
|
||||
5. Step 5
|
||||
1. [Review meeting notes](review-meeting-notes.html)
|
||||
1. [Review Meeting Notes](Review-Meeting-Notes)
|
||||
6. Step 6
|
||||
1. [Release checklist](release-checklist.html)
|
||||
1. [Release Checklist](Release-Checklist)
|
||||
7. Step 7
|
||||
1. [Installation / Quick start guide](install.html)
|
||||
2. [Release notes](Release-Notes)
|
||||
3. [User guide](userguide.html)
|
||||
4. [Demo script](demo-script.html)
|
||||
1. [Installation / Quick Start Guide](Installation-Guide)
|
||||
2. [Release Notes](Release-Notes)
|
||||
3. [User Guide](User-Guide)
|
||||
4. [Demo Script](Demo-Script)
|
||||
5. [FAQ / Troubleshooting](FAQ)
|
||||
6. [Implementation notes](implementation-notes.html)
|
||||
6. [Implementation Notes](Implementation-Notes)
|
||||
8. Every week
|
||||
1. [Status report](status-report.html)
|
||||
1. [Status Report](Status-Report)
|
||||
|
||||
### All Templates
|
||||
1. [All-in-one](all-in-one.html)
|
||||
1. [Summary](Summary)
|
||||
2. [Home](Home)
|
||||
3. [Proposal](Proposal)
|
||||
- [Target and benefits](Target-and-Benefits)
|
||||
4. [Project plan](Project-Plan)
|
||||
- [](Resource-Needs)[Resource needs](Resource-Needs)
|
||||
5. [QA Plan](qa-plan.html)
|
||||
- [Test suite](test-suite.html)
|
||||
- [Test case format](test-case-format.html)
|
||||
- [Test cases](test-cases.html)
|
||||
- [Review meeting notes](review-meeting-notes.html)
|
||||
6. [Legal issues](legal.html)
|
||||
7. [User needs](User-Needs)
|
||||
- [Interview notes](interview-notes.html)
|
||||
- [Target and Benefits](Target-and-Benefits)
|
||||
4. [Project Plan](Project-Plan)
|
||||
- [Resource needs](Resource-Needs)
|
||||
5. [QA Plan](QA-Plan)
|
||||
- [Test Suite](Test-Suite)
|
||||
- [Test Case Format](Test-Case-Format)
|
||||
- [Test Cases](Test-Cases)
|
||||
- [Review Meeting Notes](Review-Meeting-Notes)
|
||||
6. [Legal Issues](Legal)
|
||||
7. [User Needs](User-Needs)
|
||||
- [Interview Notes](Interview-Notes)
|
||||
8. [Software Requirements Specification](SRS)
|
||||
- [Use case suite](Use-Case-Suite)
|
||||
- [Feature set](Feature-Set)
|
||||
- [Use Case Suite](Use-Case-Suite)
|
||||
- [Feature Set](Feature-Set)
|
||||
9. [Glossary](Glossary)
|
||||
10. [Design](Design)
|
||||
- [Architecture worksheet](Design-Architecture)
|
||||
- [Source and build] > (Design-Src-Org)
|
||||
- [User interface worksheet](Design-UI)
|
||||
- [Persistence worksheet](Design-Persistence)
|
||||
- [Security worksheet](Design-Security)
|
||||
11. [User guide](userguide.html)
|
||||
12. [Release checklist](release-checklist.html)
|
||||
13. [Installation / Quick start guide](install.html)
|
||||
14. [Release notes](Release-Notes)
|
||||
15. [Demo script](demo-script.html)
|
||||
- [Architecture Worksheet](Design-Architecture)
|
||||
- [Source and Build](Design-Src-Org)
|
||||
- [User Interface Worksheet](Design-UI)
|
||||
- [Persistence Worksheet](Design-Persistence)
|
||||
- [Security Worksheet](Design-Security)
|
||||
11. [User Guide](User-Guide)
|
||||
12. [Release Checklist](Release-Checklist)
|
||||
13. [Installation / Quick Start Guide](Installation-Guide)
|
||||
14. [Release Notes](Release-Notes)
|
||||
15. [Demo Script](Demo-Script)
|
||||
16. [FAQ / Troubleshooting](FAQ)
|
||||
17. [Implementation notes](implementation-notes.html)
|
||||
18. [Status report](status-report.html)
|
||||
19. [Software development methodology](SDM)
|
||||
17. [Implementation Notes](Implementation-Notes)
|
||||
18. [Status Report](Status-Report)
|
||||
19. [Software Development Methodology](SDM)
|
||||
|
||||
### How to download these templates:
|
||||
- [Download template archive](http://readyset.tigris.org/servlets/ProjectDocumentList), or
|
||||
|
Loading…
Reference in New Issue
Block a user