From b8973b0979c624a05870ad1676dabf646e282f9d Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:09:37 +0200 Subject: [PATCH 01/16] Created Words of Wisdom Index (markdown) --- Words-of-Wisdom-Index.md | 67 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 Words-of-Wisdom-Index.md diff --git a/Words-of-Wisdom-Index.md b/Words-of-Wisdom-Index.md new file mode 100644 index 0000000..3c796c2 --- /dev/null +++ b/Words-of-Wisdom-Index.md @@ -0,0 +1,67 @@ +# Template List + +The following pages contain specific tips and advice on each template. + +## Project kick-off + +* Project proposal +* Target audience & benefits +* User needs & stories +* Interview notes +* All-in-one project summary + +## Project Reference Information + +* Project overview +* Glossary / Data dictionary +* Software development method + +## System requirements + +* SRS +* Use case suite +* Feature set + +## Planning + +* Project plan +* Resource needs +* Risk management +* Legal issues + +## Design + +* Design overview +* Architecture +* Persistence +* User interface +* Security +* Source organization + +## Project tracking + +* Status report +* Review meeting + +## Quality management + +* QA plan +* Test suite +* Test run log + +## Product content + +* Release notes +* Installation / Quick-start +* User Guide +* FAQ / Troubleshooting + +## Product support information + +* Implementation notes +* Demo script + +## Release end-game + +* Release checklist +* Postmortem report \ No newline at end of file From 1be1416b3957dafdc5a5e6ae9fa2ce30c62cbcc5 Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:10:18 +0200 Subject: [PATCH 02/16] Updated Words of Wisdom Index (markdown) --- Words-of-Wisdom-Index.md => Words-of-Wisdom.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename Words-of-Wisdom-Index.md => Words-of-Wisdom.md (100%) diff --git a/Words-of-Wisdom-Index.md b/Words-of-Wisdom.md similarity index 100% rename from Words-of-Wisdom-Index.md rename to Words-of-Wisdom.md From 501dc414052264d2f7dd6602c8e592b50df2e35f Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:11:35 +0200 Subject: [PATCH 03/16] Updated Words of Wisdom (markdown) --- Words-of-Wisdom.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Words-of-Wisdom.md b/Words-of-Wisdom.md index 3c796c2..78db106 100644 --- a/Words-of-Wisdom.md +++ b/Words-of-Wisdom.md @@ -1,5 +1,8 @@ # Template List +*** + + The following pages contain specific tips and advice on each template. ## Project kick-off From 39ffae8af03cc0e3957f13f07fd4ee15fbed764a Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:13:09 +0200 Subject: [PATCH 04/16] Created Words of Wisdom : proposal (markdown) --- Words-of-Wisdom-:-proposal.md | 37 +++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 Words-of-Wisdom-:-proposal.md diff --git a/Words-of-Wisdom-:-proposal.md b/Words-of-Wisdom-:-proposal.md new file mode 100644 index 0000000..02d4d73 --- /dev/null +++ b/Words-of-Wisdom-:-proposal.md @@ -0,0 +1,37 @@ +# Proposal +Line-by-line Instructions +Project +Write the name of the proposed project. +Project Time-frame +Write the proposed project start and end dates. This information will usually be appoximate. +Summary +Write an executive summary of the proposed project. It is usually best to write the proposal first and then write the highlights here. +What is the setting and history behind this project? +Briefly describe how the need for this project arose and was recognized. This helps motivate the product, put it into the context of the overall business, and can help identify project stakeholders. +What business problem does this project address? +Use 2-4 sentences to describe the problem that your potential users are having right now. Focus on business problems, not technical problems. If you are trying to solve a technical problem, describe the business need that makes that technical problem important enough to solve. Do not say anything about your solution here. +What are some current approaches to this problem? +List some of the alternatives that your potential customers have now. Listing these now will help set requirements for your product to be better than these alternatives, and it will help identify the expectations of potential customers that have already been using the alternatives. +Why is this problem worth solving or worth solving better? +Explain why a better product would matter to customers or project stakeholders. Your argument would ideally impact business metrics such as profit, costs, revenue, sales, time-to-market, brand value, size of customer base, or return on investment. +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. +Where is there more information on this problem? +Link to more information on the problem that customers face. Is this problem growing? Is the problem big enough to create enough demand for the product? These documents should support the decision to authorize the project by explaining the need. +What is the goal of this project? +Write 2-4 sentences or bullets on your main goal for the project. Briefly, name your target audiance and mention key benefits that your customers will gain by using your product. +What are the defining features and benefits of this product? +Briefly list the most important features of the product. It is alright to reiterate features found in the alternative products, but focus on the unique features that will set this product apart. +Where are other documents that further explain the goal of this project? +If you have other documents that support this project proposal, link to them from here. These documents should support the decision to authorize the project by explaining the value of the proposed solution. +Scope +There are several useful formats for explaining the scope of a proposed project. A good scope description provides insight into the resources that may be needed for the project and helps you avoid feature creep later. +The simplest format is just a paragraph: give 2-4 sentences that summarize what you intend to do as part of this project. It is often a good idea to explicitly state some things that will not be done. +Another way to document the scope of a project is to use two bullet lists: one for things that are in scope, and one for things that are out of scope. +The third and best format is a table with columns that list things that are in scope and out of scope. Each row of the table defines a direction, the first column says how far you plan to go in that direction, and the second column names something that is too far in that direction. +Deliverables +Briefly list the deliverables in enough detail to support the decision to authorize the project. You can describe deliverables in more detail in the project plan. +Risks and Rewards +Briefly list risks to the success of the project and the main rewards to the organization if the project succeeds. Include enough information to support the decision whether to authorize the project. Later, you can describe and track project risks in more detail in the risk management worksheet. +Project Plan +Link to a draft of the project plan. \ No newline at end of file From 6a48cc2e64484b389965a78c623b3576543f51c1 Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:17:16 +0200 Subject: [PATCH 05/16] Updated _Footer (markdown) --- _Footer.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_Footer.md b/_Footer.md index 4aac9eb..77bd7f4 100644 --- a/_Footer.md +++ b/_Footer.md @@ -1,3 +1,5 @@ +TODO: Check for [words of wistom](https://github.com/bike-bill/readyset-gfm) for additional advice on this template. + ::**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. From c88c6f2566a656d1d4b612e5e57dc0fdea3dc6dc Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:20:05 +0200 Subject: [PATCH 06/16] Updated _Footer (markdown) --- _Footer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_Footer.md b/_Footer.md index 77bd7f4..345e849 100644 --- a/_Footer.md +++ b/_Footer.md @@ -1,4 +1,4 @@ -TODO: Check for [words of wistom](https://github.com/bike-bill/readyset-gfm) for additional advice on this template. +TODO: Check for [words of wisdom](https://github.com/bike-bill/readyset-gfm/wiki/Words-of-Wisdom) for additional advice on this template. ::**Your-Organization Proprietary** From 4affbe23f6d285be2bba38297393108fe56eb36b Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:20:42 +0200 Subject: [PATCH 07/16] Updated _Sidebar (markdown) --- _Sidebar.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_Sidebar.md b/_Sidebar.md index afea11b..ce85140 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -1,4 +1,5 @@ * [Home](Home) * [Summary](Summary) * [Project Plan](Project-Plan) -* [Workflows](Workflows) \ No newline at end of file +* [Workflows](Workflows) +* [Words of Wisdom](https://github.com/bike-bill/readyset-gfm/wiki/Words-of-Wisdom) \ No newline at end of file From 0e61cf8dee7749232fd02ac8bb464f160d2a9007 Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:27:47 +0200 Subject: [PATCH 08/16] Updated Words of Wisdom : proposal (markdown) --- ...proposal.md => Words-of-Wisdom:Proposal.md | 54 +++++++++++++------ 1 file changed, 37 insertions(+), 17 deletions(-) rename Words-of-Wisdom-:-proposal.md => Words-of-Wisdom:Proposal.md (83%) diff --git a/Words-of-Wisdom-:-proposal.md b/Words-of-Wisdom:Proposal.md similarity index 83% rename from Words-of-Wisdom-:-proposal.md rename to Words-of-Wisdom:Proposal.md index 02d4d73..33bfd3c 100644 --- a/Words-of-Wisdom-:-proposal.md +++ b/Words-of-Wisdom:Proposal.md @@ -1,37 +1,57 @@ # Proposal -Line-by-line Instructions -Project + +## Line-by-line Instructions + +### Project Write the name of the proposed project. -Project Time-frame + +### Project Time-frame Write the proposed project start and end dates. This information will usually be appoximate. -Summary + +### Summary Write an executive summary of the proposed project. It is usually best to write the proposal first and then write the highlights here. -What is the setting and history behind this project? + +### What is the setting and history behind this project? Briefly describe how the need for this project arose and was recognized. This helps motivate the product, put it into the context of the overall business, and can help identify project stakeholders. -What business problem does this project address? + +### What business problem does this project address? Use 2-4 sentences to describe the problem that your potential users are having right now. Focus on business problems, not technical problems. If you are trying to solve a technical problem, describe the business need that makes that technical problem important enough to solve. Do not say anything about your solution here. -What are some current approaches to this problem? + +### What are some current approaches to this problem? List some of the alternatives that your potential customers have now. Listing these now will help set requirements for your product to be better than these alternatives, and it will help identify the expectations of potential customers that have already been using the alternatives. -Why is this problem worth solving or worth solving better? + +### Why is this problem worth solving or worth solving better? Explain why a better product would matter to customers or project stakeholders. Your argument would ideally impact business metrics such as profit, costs, revenue, sales, time-to-market, brand value, size of customer base, or return on investment. -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. -Where is there more information on this problem? + +### Where is there more information on this problem? Link to more information on the problem that customers face. Is this problem growing? Is the problem big enough to create enough demand for the product? These documents should support the decision to authorize the project by explaining the need. -What is the goal of this project? + +### What is the goal of this project? Write 2-4 sentences or bullets on your main goal for the project. Briefly, name your target audiance and mention key benefits that your customers will gain by using your product. -What are the defining features and benefits of this product? + +### What are the defining features and benefits of this product? Briefly list the most important features of the product. It is alright to reiterate features found in the alternative products, but focus on the unique features that will set this product apart. -Where are other documents that further explain the goal of this project? + +### Where are other documents that further explain the goal of this project? If you have other documents that support this project proposal, link to them from here. These documents should support the decision to authorize the project by explaining the value of the proposed solution. -Scope + +### Scope There are several useful formats for explaining the scope of a proposed project. A good scope description provides insight into the resources that may be needed for the project and helps you avoid feature creep later. + The simplest format is just a paragraph: give 2-4 sentences that summarize what you intend to do as part of this project. It is often a good idea to explicitly state some things that will not be done. + Another way to document the scope of a project is to use two bullet lists: one for things that are in scope, and one for things that are out of scope. + The third and best format is a table with columns that list things that are in scope and out of scope. Each row of the table defines a direction, the first column says how far you plan to go in that direction, and the second column names something that is too far in that direction. -Deliverables + +### Deliverables Briefly list the deliverables in enough detail to support the decision to authorize the project. You can describe deliverables in more detail in the project plan. -Risks and Rewards + +### Risks and Rewards Briefly list risks to the success of the project and the main rewards to the organization if the project succeeds. Include enough information to support the decision whether to authorize the project. Later, you can describe and track project risks in more detail in the risk management worksheet. -Project Plan + +### Project Plan Link to a draft of the project plan. \ No newline at end of file From 75a9113209766f94dafcd4f0b846eae7b78846f3 Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:30:41 +0200 Subject: [PATCH 09/16] Updated Words of Wisdom (markdown) --- Words-of-Wisdom.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Words-of-Wisdom.md b/Words-of-Wisdom.md index 78db106..87e5fbe 100644 --- a/Words-of-Wisdom.md +++ b/Words-of-Wisdom.md @@ -1,8 +1,9 @@ +The original [ReadySET Pro](http://readysetpro.com) words of wisdom are [here](http://www.readysetpro.com/words-of-wisdom). + # Template List *** - The following pages contain specific tips and advice on each template. ## Project kick-off From 9a0e6f9c66edf702cbcc4906096e65e69580b69b Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:31:58 +0200 Subject: [PATCH 10/16] Updated Words of Wisdom (markdown) --- Words-of-Wisdom.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Words-of-Wisdom.md b/Words-of-Wisdom.md index 87e5fbe..6094357 100644 --- a/Words-of-Wisdom.md +++ b/Words-of-Wisdom.md @@ -8,7 +8,7 @@ The following pages contain specific tips and advice on each template. ## Project kick-off -* Project proposal +* [Project proposal](https://github.com/bike-bill/readyset-gfm/wiki/Words-of-Wisdom:Proposal) * Target audience & benefits * User needs & stories * Interview notes From dd0957f8faa0b4aba16d60ebc7f2b6b0e32db0c5 Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:41:46 +0200 Subject: [PATCH 11/16] Updated _Sidebar (markdown) --- _Sidebar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_Sidebar.md b/_Sidebar.md index ce85140..05d9459 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -2,4 +2,4 @@ * [Summary](Summary) * [Project Plan](Project-Plan) * [Workflows](Workflows) -* [Words of Wisdom](https://github.com/bike-bill/readyset-gfm/wiki/Words-of-Wisdom) \ No newline at end of file +* [Words of Wisdom](Words-of-Wisdom) \ No newline at end of file From c67cc4a429fe61e822d190ded8bd8576923ffc50 Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:42:18 +0200 Subject: [PATCH 12/16] Updated _Footer (markdown) --- _Footer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_Footer.md b/_Footer.md index 345e849..06fc364 100644 --- a/_Footer.md +++ b/_Footer.md @@ -1,4 +1,4 @@ -TODO: Check for [words of wisdom](https://github.com/bike-bill/readyset-gfm/wiki/Words-of-Wisdom) for additional advice on this template. +TODO: Check for [words of wisdom](Words-of-Wisdom) for additional advice on this template. ::**Your-Organization Proprietary** From 43ade90190cfdf1f5f5a0327bb07f069f926ca1d Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:42:50 +0200 Subject: [PATCH 13/16] Updated Words of Wisdom (markdown) --- Words-of-Wisdom.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Words-of-Wisdom.md b/Words-of-Wisdom.md index 6094357..784a6c5 100644 --- a/Words-of-Wisdom.md +++ b/Words-of-Wisdom.md @@ -8,7 +8,7 @@ The following pages contain specific tips and advice on each template. ## Project kick-off -* [Project proposal](https://github.com/bike-bill/readyset-gfm/wiki/Words-of-Wisdom:Proposal) +* [Project proposal](Words-of-Wisdom:Proposal) * Target audience & benefits * User needs & stories * Interview notes From 4a6426e0ad3a85f536c8416bcbbccedcc8d49ac0 Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:44:08 +0200 Subject: [PATCH 14/16] Updated Words of Wisdom (markdown) --- Words-of-Wisdom.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Words-of-Wisdom.md b/Words-of-Wisdom.md index 784a6c5..e708fe0 100644 --- a/Words-of-Wisdom.md +++ b/Words-of-Wisdom.md @@ -8,7 +8,7 @@ The following pages contain specific tips and advice on each template. ## Project kick-off -* [Project proposal](Words-of-Wisdom:Proposal) +* [Project proposal](Words-of-Wisdom-Proposal) * Target audience & benefits * User needs & stories * Interview notes From 152905a86cad16e59b3a4fbe0f03d8a3a2e1dff7 Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:44:42 +0200 Subject: [PATCH 15/16] Updated Words of Wisdom:Proposal (markdown) --- Words-of-Wisdom:Proposal.md => Words-of-Wisdom-Proposal.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename Words-of-Wisdom:Proposal.md => Words-of-Wisdom-Proposal.md (100%) diff --git a/Words-of-Wisdom:Proposal.md b/Words-of-Wisdom-Proposal.md similarity index 100% rename from Words-of-Wisdom:Proposal.md rename to Words-of-Wisdom-Proposal.md From df9e14d83990840c5d3bfef26f9de6de88b8eb1b Mon Sep 17 00:00:00 2001 From: William Sandner Date: Tue, 4 Aug 2020 13:46:28 +0200 Subject: [PATCH 16/16] Updated _Footer (markdown) --- _Footer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_Footer.md b/_Footer.md index 06fc364..274c134 100644 --- a/_Footer.md +++ b/_Footer.md @@ -1,4 +1,4 @@ -TODO: Check for [words of wisdom](Words-of-Wisdom) for additional advice on this template. +**TODO:** Check for [words of wisdom](Words-of-Wisdom) for additional advice on this template. ::**Your-Organization Proprietary**