-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b6b87a7
commit a446ade
Showing
1 changed file
with
87 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| # Project Title | ||
|
|
||
| A brief description of your project, its purpose, and the target audience. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Project Overview](#project-overview) | ||
| - [User Stories](#user-stories) | ||
| - [Wireframes](#wireframes) | ||
| - [Setup and Installation](#setup-and-installation) | ||
| - [Features](#features) | ||
| - [Testing](#testing) | ||
| - [Deployment](#deployment) | ||
| - [Credits](#credits) | ||
| - [Documentation Tasks](#documentation-tasks) | ||
|
|
||
| ## Project Overview | ||
|
|
||
| ### Purpose | ||
| Very brifley the purpose of the project and its target audience. | ||
|
|
||
| ### Key Project Goals | ||
| List the main goals of your project. | ||
|
|
||
| ## User Stories | ||
|
|
||
| ### Must Have | ||
| 1. As a [type of user], I want [some goal] so that [some reason]. | ||
| Acceptance criteria | ||
| 3. ... | ||
| Acceptance criteria | ||
| ### Should Have | ||
| 1. As a [type of user], I want [some goal] so that [some reason]. | ||
| Acceptance criteria | ||
| 3. ... | ||
| Acceptance criteria | ||
| ### Could Have | ||
| 1. As a [type of user], I want [some goal] so that [some reason]. | ||
| Acceptance criteria | ||
| 3. ... | ||
| Acceptance criteria | ||
|
|
||
| ### Implemented User Stories | ||
| - [ ] Must Have 1 | ||
| - [ ] Must Have 2 | ||
| - [ ] Should Have 1 | ||
| - [ ] Could Have 1 | ||
|
|
||
| ### Not Implemented User Stories | ||
| - [ ] Should Have 2 | ||
| - [ ] Could Have 2 | ||
|
|
||
| ## Wireframes | ||
|
|
||
| Include screenshots or links to your wireframes here. | ||
|
|
||
|
|
||
| # Testing | ||
|
|
||
| ## Testing Overview | ||
| Describe the testing strategy and tools used. | ||
|
|
||
| ## Test Cases | ||
| - **Test Case 1**: Description of what was tested and the results. | ||
| - **Test Case 2**: Description of what was tested and the results. | ||
| - ... | ||
|
|
||
| ## Bugs | ||
| - **Bug 1**: Description of one major bug, how it was found, and how it was fixed. | ||
| - **Unfixed Bug 1**: Description of any major bug that was not fixed and why. | ||
|
|
||
|
|
||
| ## Deployment Steps | ||
| 1. Deploy to GitHub Pages. | ||
| 2. Verify all links and features are working correctly. | ||
|
|
||
| # Credits | ||
|
|
||
| ## Code Attribution | ||
| List any external code used and its source. | ||
|
|
||
| ## Acknowledgements | ||
| List any individuals or resources that helped in the development of the project. | ||
|
|
||
|
|
||
|
|
||
|
|