diff --git a/Feature-Format.md b/Feature-Format.md index 32680bc..d1bb0c7 100644 --- a/Feature-Format.md +++ b/Feature-Format.md @@ -1,35 +1,21 @@ - - - - - - ReadySet Markdown - - - +##### Project: +::[PROJECTNAME](Home) - - Overview - Project Plan - Workflows - Current - - +##### Internal Release Number: +::X.Y.Z - -<!-- Markdown content here --> - -# [SRS](SRS) > [Feature Set](Feature-Set) > Feature Specification Format +##### Related Documents: +- [SRS](SRS) > [Feature Set](Feature-Set) > Feature Specification Format --- **Process impact:** This reference page documents the format of feature descriptions and gives tips on writing them. You can copy and paste the -feature specification template into your [Features](features.html) +feature specification template into your [Features](Features) document. This file itself should not be edited to hold specific features. *TODO: Copy and paste this feature specification template as many times -as needed in your [Features](features.html) document.* +as needed in your [Features](Features) document.* --- ### ::F-00: FEATURE NAME @@ -42,7 +28,7 @@ Risk: ::Dangerous | 3-Risk | 2-Risk | 1-Risk | Safe Functional area(s): ::WORD, WORD, WORD -Use case(s): ::[UC-01](use-cases.html#UC-01) +Use case(s): ::[UC-01](Use-Cases#UC-01) Description: diff --git a/Feature-Set.md b/Feature-Set.md index 8adb603..e0ed7e5 100644 --- a/Feature-Set.md +++ b/Feature-Set.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 --> - -# [SRS](SRS) > Feature Set ---- - ##### Project: ::PROJECTNAME @@ -29,11 +5,12 @@ ::X.Y.Z ##### Related Documents: -- [Project proposal](proposal.html) > [User needs](user-needs.html) +- [SRS](SRS) > Feature Set +- [Project proposal](Proposal) > [User needs](User-Needs) - [SRS](SRS) > [Use case suite](Use-Case-Suite) -- [Feature format](feature-format.html) +- [Feature format](Feature-Format) - ::LINK TO USE CASE DIAGRAM -- ::LINKS TO RELEVANT STANDARDSuser-needs +- ::LINKS TO RELEVANT STANDARDS - ::LINKS TO OTHER DOCUMENTS --- @@ -65,97 +42,76 @@ consider estimated effort and risk.* - ::Release 1.0 - ::Essential - - ::[F-00](features.html#f-00_site_configuration) Site configuration - - ::[F-01](features.html#f-01_user_regisration) User registration - - ::[F-21](features.html#f-21_feature_name) NAME OF FEATURE - - ::[F-31](features.html#f-31_feature_name) NAME OF FEATURE + - ::[F-00](Features#f-00_site_configuration) Site configuration + - ::[F-01](Features#f-01_user_regisration) User registration + - ::[F-21](Features#f-21_feature_name) NAME OF FEATURE + - ::[F-31](Features#f-31_feature_name) NAME OF FEATURE - ::Expected - - ::[F-02](features.html#f-02_feature_name) NAME OF FEATURE - - ::[F-03](features.html#f-03_feature_name) NAME OF FEATURE - - ::[F-20](features.html#f-20_feature_name) NAME OF FEATURE + - ::[F-02](Features#f-02_feature_name) NAME OF FEATURE + - ::[F-03](Features#f-03_feature_name) NAME OF FEATURE + - ::[F-20](Features#f-20_feature_name) NAME OF FEATURE - ::Release 1.1 - ::Expected - - ::[F-22](features.html#f-22_feature_name) NAME OF FEATURE - - ::[F-23](features.html#f-23_feature_name) NAME OF FEATURE - - ::[F-33](features.html#f-33_feature_name) NAME OF FEATURE + - ::[F-22](Features#f-22_feature_name) NAME OF FEATURE + - ::[F-23](Features#f-23_feature_name) NAME OF FEATURE + - ::[F-33](Features#f-33_feature_name) NAME OF FEATURE - ::Desired - - ::[F-10](features.html#f-10_feature_name) NAME OF FEATURE - - ::[F-11](features.html#f-11_feature_name) NAME OF FEATURE - - ::[F-12](features.html#f-12_feature_name) NAME OF FEATURE + - ::[F-10](Features#f-10_feature_name) NAME OF FEATURE + - ::[F-11](Features#f-11_feature_name) NAME OF FEATURE + - ::[F-12](Features#f-12_feature_name) NAME OF FEATURE - ::Later Releases - ::Optional - - ::[F-30](features.html#f-30_feature_name) NAME OF FEATURE - - ::[F-32](features.html#f-32_feature_name) NAME OF FEATURE + - ::[F-30](Features#f-30_feature_name) NAME OF FEATURE + - ::[F-32](Features#f-32_feature_name) NAME OF FEATURE ### Features by Release and Risk - ::Release 1.0 - - ::[F-00](features.html#f-00_site_configurtion) Safe : Site configuration - - ::[F-01](features.html#f-01_user_registration) Safe : User registration - - ::[F-21](features.html#f-21_feature_name) Safe : NAME OF FEATURE - - ::[F-31](features.html#f-31_feature_name) 1-Risk : NAME OF FEATURE - - ::[F-02](features.html#f-02_feature_name) 1-Risk : NAME OF FEATURE - - ::[F-03](features.html#f-03_feature_name) 2-Risks : NAME OF FEATURE - - ::[F-20](features.html#f-20_feature_name) 2-Risks : NAME OF FEATURE + - ::[F-00](Features#f-00_site_configurtion) Safe : Site configuration + - ::[F-01](Features#f-01_user_registration) Safe : User registration + - ::[F-21](Features#f-21_feature_name) Safe : NAME OF FEATURE + - ::[F-31](Features#f-31_feature_name) 1-Risk : NAME OF FEATURE + - ::[F-02](Features#f-02_feature_name) 1-Risk : NAME OF FEATURE + - ::[F-03](Features#f-03_feature_name) 2-Risks : NAME OF FEATURE + - ::[F-20](Features#f-20_feature_name) 2-Risks : NAME OF FEATURE - ::Total unique risk factors: 4 - ::Release 1.1 - - ::[F-22](features.html#f-22_feature_name) Safe : NAME OF FEATURE - - ::[F-23](features.html#f-23_feature_name) Safe : NAME OF FEATURE - - ::[F-33](features.html#f-33_feature_name) Safe : NAME OF FEATURE - - ::[F-10](features.html#f-10_feature_name) 2-Risks : NAME OF FEATURE - - ::[F-11](features.html#f-11_feature_name) 2-Risks : NAME OF FEATURE - - ::[F-12](features.html#f-12_feature_name) 3-Risks : NAME OF FEATURE + - ::[F-22](Features#f-22_feature_name) Safe : NAME OF FEATURE + - ::[F-23](Features#f-23_feature_name) Safe : NAME OF FEATURE + - ::[F-33](Features#f-33_feature_name) Safe : NAME OF FEATURE + - ::[F-10](Features#f-10_feature_name) 2-Risks : NAME OF FEATURE + - ::[F-11](Features#f-11_feature_name) 2-Risks : NAME OF FEATURE + - ::[F-12](Features#f-12_feature_name) 3-Risks : NAME OF FEATURE - ::Total unique risk factors: 5 - ::Later Releases - - ::[F-30](features.html#f-30_feature_name) Safe : NAME OF FEATURE - - ::[F-32](features.html#f-32_feature_name) 2-Risks : NAME OF FEATURE + - ::[F-30](Features#f-30_feature_name) Safe : NAME OF FEATURE + - ::[F-32](Features#f-32_feature_name) 2-Risks : NAME OF FEATURE - ::Total unique risk factors: 2 ### Features by Functional Area - ::FUNCTIONAL AREA ONE - - ::[F-00](features.html#f-00_site_configuration) Site configuration - - ::[F-01](features.html#f-01_user_registration) User registration - - ::[F-02](features.html#f-02_feature_name) NAME OF FEATURE - - ::[F-03](features.html#f-03_feature_name) NAME OF FEATURE + - ::[F-00](Features#f-00_site_configuration) Site configuration + - ::[F-01](Features#f-01_user_registration) User registration + - ::[F-02](Features#f-02_feature_name) NAME OF FEATURE + - ::[F-03](Features#f-03_feature_name) NAME OF FEATURE - ::FUNCTIONAL AREA TWO - - ::[F-10](features.html#f-10_feature_name) NAME OF FEATURE - - ::[F-11](features.html#f-11_feature_name) NAME OF FEATURE - - ::[F-12](features.html#f-12_feature_name) NAME OF FEATURE - - ::[F-13](features.html#f-13_feature_name) NAME OF FEATURE + - ::[F-10](Features#f-10_feature_name) NAME OF FEATURE + - ::[F-11](Features#f-11_feature_name) NAME OF FEATURE + - ::[F-12](Features#f-12_feature_name) NAME OF FEATURE + - ::[F-13](Features#f-13_feature_name) NAME OF FEATURE - ::FUNCTIONAL AREA THREE - - ::[F-20](features.html#f-20_feature_name) NAME OF FEATURE - - ::[F-21](features.html#f-21_feature_name) NAME OF FEATURE - - ::[F-22](features.html#f-22_feature_name) NAME OF FEATURE - - ::[F-23](features.html#f-23_feature_name) NAME OF FEATURE + - ::[F-20](Features#f-20_feature_name) NAME OF FEATURE + - ::[F-21](Features#f-21_feature_name) NAME OF FEATURE + - ::[F-22](Features#f-22_feature_name) NAME OF FEATURE + - ::[F-23](Features#f-23_feature_name) NAME OF FEATURE - ::FUNCTIONAL AREA FOUR - ::N/A: These features are completely automated and internal, users never interact with them - ::FUNCTIONAL AREA FIVE - ::TODO: need to write use cases here - ::Other functional areas - - ::[F-30](features.html#f-30_feature_name) NAME OF FEATURE - - ::[F-31](features.html#f-31_feature_name) NAME OF FEATURE - - ::[F-32](features.html#f-32_feature_name) NAME OF FEATURE - - ::[F-33](features.html#f-33_feature_name) NAME OF FEATURE - - -<!-- End Markdown content --> - - -
-
- - - - - - - - - - - - + - ::[F-30](Features#f-30_feature_name) NAME OF FEATURE + - ::[F-31](Features#f-31_feature_name) NAME OF FEATURE + - ::[F-32](Features#f-32_feature_name) NAME OF FEATURE + - ::[F-33](Features#f-33_feature_name) NAME OF FEATURE diff --git a/Features.md b/Features.md index 69cd21e..192e13a 100644 --- a/Features.md +++ b/Features.md @@ -1,27 +1,3 @@ - - - - - - ReadySet Markdown - - - - - - Overview - Project Plan - Workflows - Current - - - - -<!-- Markdown content here --> - -# [SRS](SRS) > [Feature Set](Feature-Set) > Features ---- - ##### Project: ::PROJECTNAME @@ -29,9 +5,10 @@ ::X.Y.Z ##### Related Documents: -- [Project proposal](proposal.html) > [User needs](user-needs.html) +- [SRS](SRS) > [Feature Set](Feature-Set) > Features +- [Feature format](Feature-Format) +- [Project proposal](Proposal) > [User needs](User-Needs) - [SRS](SRS) > [Use case suite](Use-Case-Suite) -- [Feature format](feature-format.html) - ::LINKS TO RELEVANT STANDARDS - ::LINKS TO OTHER DOCUMENTS --- @@ -500,24 +477,3 @@ Notes and Questions: - ::NOTE - ::QUESTION - - -<!-- End Markdown content --> - - -
-
- - - - - - - - - - - - diff --git a/Interview-Checklist.md b/Interview-Checklist.md index 99a3db7..8461e00 100644 --- a/Interview-Checklist.md +++ b/Interview-Checklist.md @@ -23,7 +23,7 @@ --- ##### Related documents: -- [User Needs](user-needs.html) +- [User Needs](User-Needs) - [Interview Notes](interview-notes.html) --- diff --git a/Interview-Notes.md b/Interview-Notes.md index 3fdc1d0..d01d5cd 100644 --- a/Interview-Notes.md +++ b/Interview-Notes.md @@ -19,7 +19,7 @@ <!-- Markdown content here --> -# [User Needs](user-needs.html) > Interview&nbsp;Notes +# [User Needs](User-Needs) > Interview&nbsp;Notes --- ##### Project: @@ -38,7 +38,7 @@ ::LOCATION ##### Related Documents: -- [Project proposal](proposal.html) > [Target audience and benefits](Target-and-Benefits) +- [Project proposal](Proposal) > [Target audience and benefits](Target-and-Benefits) - [Interview checklist](interview-checklist.html) - [Glossary](Glossary) --- @@ -50,7 +50,7 @@ of user-needs.md.* **Process impact:** Planning questions for interviews with stakeholders is key to effective requirements gathering. Good requirements are needed to build the right system. These notes should be kept as part of the -documentation on [user needs](user-needs.html) are referred to when the +documentation on [user needs](User-Needs) are referred to when the [software requirements specification](SRS) is written or updated. ### Interview Questions and Answers diff --git a/Legal.md b/Legal.md index 8741ca6..28b04c5 100644 --- a/Legal.md +++ b/Legal.md @@ -38,7 +38,7 @@ ::Commercial license ##### Related Documents: -- [Project proposal](proposal.html) > [Target audience and benefits](Target-and-Benefits) +- [Project proposal](Proposal) > [Target audience and benefits](Target-and-Benefits) - [Plan](plan) > [Resource needs](Resource-Needs) - [Glossary](Glossary) --- diff --git a/Project-Plan.md b/Project-Plan.md index 59148a3..6c3f661 100644 --- a/Project-Plan.md +++ b/Project-Plan.md @@ -26,7 +26,7 @@ needed. Use the worksheet to help identify and scope resource needs.* ### Summary of Project #### What are the business problem, scope, and goal of this project? -For a summary of this project, see the [Project proposal](proposal.html). +For a summary of this project, see the [Project proposal](Proposal). #### Who will sponsor, manage, and lead the project? diff --git a/Resource-Needs.md b/Resource-Needs.md index ff4516d..a52dd9c 100644 --- a/Resource-Needs.md +++ b/Resource-Needs.md @@ -13,7 +13,7 @@ ::STARTDATE - ENDDATE ##### Related Documents: -- [Project proposal](proposal.html) +- [Project proposal](Proposal) - [Project plan](Project-Plan) - [QA plan](qa-plan.html) - [Software development methodology](SDM) diff --git a/SRS.md b/SRS.md index 47a293e..2b19699 100644 --- a/SRS.md +++ b/SRS.md @@ -33,7 +33,7 @@ - SRS > [Feature set](Feature-Set) ##### Related Documents: -- [Project proposal](proposal.html) > [User needs](user-needs.html) +- [Project proposal](Proposal) > [User needs](User-Needs) - ::LINKS TO RELEVANT STANDARDS - ::LINKS TO OTHER DOCUMENTS - [Glossary](Glossary) @@ -55,7 +55,7 @@ copy text from the project proposal, paste it here, and shorten it.* ::PARAGRAPH -For more information, see the project [proposal](proposal.html). +For more information, see the project [proposal](Proposal). ### Use Cases @@ -63,7 +63,7 @@ For more information, see the project [proposal](proposal.html). Details: -- Actors are described in the [user needs](user-needs.html) document. +- Actors are described in the [user needs](User-Needs) document. - The [use case suite](Use-Case-Suite) lists all use cases in an organized way. diff --git a/Summary.md b/Summary.md index 3414d58..101bf74 100644 --- a/Summary.md +++ b/Summary.md @@ -61,7 +61,7 @@ and [legal issues](legal.html) documents.* ### Requirements *TODO: Briefly describe the most important system requirements. This is -condensed from the [user needs](user-needs.html), +condensed from the [user needs](User-Needs), [interview notes](interview-notes.html), [SRS](SRS), [use case suite](Use-Case-Suite), and [feature set](Feature-Set) documents.* diff --git a/Target-and-Benefits.md b/Target-and-Benefits.md index 26905dc..ce86610 100644 --- a/Target-and-Benefits.md +++ b/Target-and-Benefits.md @@ -19,7 +19,7 @@ <xmp theme="readable" style="display:none;"> <!-- Markdown content here --> -# [Proposal](proposal.html) > Target Audience and Benefits +# [Proposal](Proposal) > Target Audience and Benefits --- ##### Project: @@ -29,7 +29,7 @@ ::X.Y.Z ##### Related Documents: -- [Project proposal](proposal.html) > [User needs](user-needs.html) +- [Project proposal](Proposal) > [User needs](User-Needs) - [Glossary](Glossary) --- diff --git a/Use-ases.md b/Use-ases.md index f10e93f..1dcda75 100644 --- a/Use-ases.md +++ b/Use-ases.md @@ -29,7 +29,7 @@ ::X.Y.Z ##### Related Documents: -- [Project proposal](proposal.html) > [User needs](user-needs.html), [SRS](SRS) > [Feature set](Feature-Set) +- [Project proposal](Proposal) > [User needs](User-Needs), [SRS](SRS) > [Feature set](Feature-Set) - [Use case format](use-case-format) - ::LINK TO USE CASE DIAGRAM - ::LINKS TO RELEVANT STANDARDS diff --git a/User-Needs.md b/User-Needs.md index cbe28b5..6baa9c7 100644 --- a/User-Needs.md +++ b/User-Needs.md @@ -29,7 +29,7 @@ - User needs > [Interview notes](interview-notes.html) ##### Related Documents: -- [Project proposal](proposal.html) > [Target audience and benefits](Target-and-Benefits) +- [Project proposal](Proposal) > [Target audience and benefits](Target-and-Benefits) - [Software requirements specification](SRS) - [Glossary](Glossary) --- diff --git a/Workflows.md b/Workflows.md index 80715ce..8f49e6c 100644 --- a/Workflows.md +++ b/Workflows.md @@ -1,14 +1,14 @@ ### By Activity 1. Project Planning 1. [Home](Home) - 2. [Proposal](proposal.html) + 2. [Proposal](Proposal) - [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) 2. Requirements and Specification - 1. [User needs](user-needs.html) + 1. [User needs](User-Needs) - [Interview notes](interview-notes.html) 2. [Software Requirements Specification](SRS) - [Use case suite](Use-Case-Suite) @@ -42,14 +42,14 @@ ### By Suggested Sequence 1. Step 1 1. [Home](Home) - 2. [Proposal](proposal.html) + 2. [Proposal](Proposal) - [](Target-and-Benefits)[Target and benefits](Target-and-Benefits) 3. [Project plan](Project-Plan) - [Resource needs](Resource-Needs) 4. [Legal issues](legal.html) 5. [Glossary](Glossary) 2. Step 2 - 1. [User needs](user-needs.html) + 1. [User needs](User-Needs) - [Interview notes](interview-notes.html) 2. [Software Requirements Specification](SRS) - [Use case suite](Use-Case-Suite) @@ -83,7 +83,7 @@ ### All Templates 1. [All-in-one](all-in-one.html) 2. [Home](Home) -3. [Proposal](proposal.html) +3. [Proposal](Proposal) - [Target and benefits](Target-and-Benefits) 4. [Project plan](Project-Plan) - [](Resource-Needs)[Resource needs](Resource-Needs) @@ -93,7 +93,7 @@ - [Test cases](test-cases.html) - [Review meeting notes](review-meeting-notes.html) 6. [Legal issues](legal.html) -7. [User needs](user-needs.html) +7. [User needs](User-Needs) - [Interview notes](interview-notes.html) 8. [Software Requirements Specification](SRS) - [Use case suite](Use-Case-Suite)