Added team recommendations and changes to GDD MVP AND SRS docs

assignments/week2/GoalsandMilestones.txt

@@ -1,30 +1,31 @@
 # Week 2 Project Goals and Milestones for The Web Game Devs
 
-This week, our team focused on laying the groundwork for our project. We aim to create a responsive, one-page website featuring an interactive Hangman game centered on programming concepts. Below I broke it down following similar SDLC processes that I have used previously for various projects in the industry, I included an Software Requirement Specifications (SRS) document for the web design portion (following IEEE’s template), and Game Development Document (GDD) for the game development, as well as a Minimum Viable Product (MVP) sheet.  
+**Team Members:** Charles Bostwick, Jade Pearl, Ada Truong, Robyn LaMontagne, Holland Brawner
 
-## Key Milestones:
+This week, our team focused on laying the groundwork for our project. We aim to create a responsive, one-page website featuring an interactive Hangman game centered on programming concepts. Below, I broke it down following similar SDLC processes that I have used previously for various projects in the industry; I included a Software Requirement Specifications (SRS) document for the web design portion (following IEEE’s template) and a Game Development Document (GDD) for the game development, as well as a Minimum Viable Product (MVP) sheet.
+
+I provided the initial layout to our team in Discord and via GitHub so that we could collaborate and review it. After discussing with the team on Discord and using Trello, we collectively created a roadmap for this project. Below is an image of our Trello board
+
+We then took the team's feedback in our Discord channels and discussions to implement the changes and recommendations to finalize the initial draft based on an IEEE template for the SRS. Below, we have broken it down to align with the assignment rubric and the post requirements for the class. We have our Key Milestones, the discussed SRS, GDD, and MVP documents, and some of the references and documentation we will be using at the end in APA formatting.
+
+## **Key Milestones:**
 
 1. Requirements and Documentation:
 - Finalize and review the Software Requirements Specification (SRS) and Game Design Document (GDD), incorporating our MVP (Minimum Viable Product) strategy. (Charles leads, with contributions from all members for feedback.)
 1. Development Environment Setup:
 - Establish the development environment with Godot 4.2 and configure the tools for HTML5 web export. (Charles and Jade)
 - Create a GitHub repository for version control and collaboration on the project. (Charles will initialize it, and everyone will clone and set it up in VSCode.)
-- Use Trello board for agile project management, defining our workflow and initial tasks. (Start breaking down the weeks for the project to set deadlines and goals.)
+- We use the Trello board for agile project management, defining our workflow and initial tasks. (Start breaking down the weeks for the project to set deadlines and goals.)
+- Determine if additional milestones, such as writing tests and deploying the website on GitHub Pages, are necessary.
 1. Initial Game and Website Development:
 - Start developing the Hangman game in GDScript, emphasizing core mechanics and the programming-related word database. (Jade/ Charles)
 - Begin designing and coding the website's layout, ensuring responsiveness and including placeholders for the game, team information, and other relevant sections. (Robyn, Ada, and Holland focus on website layout design.)
+- Discuss the potential inclusion of multiple pages in the website structure and the necessity of a navigation bar.
 1. Design Considerations:
 - Decide on a cohesive color palette for the website and game to ensure a unified look and feel. (Ada leads the design choice, with input from Jade and Robyn.)
 1. Team Collaboration and Communication:
 - Regularly communicate through Discord to stay updated on progress and hurdles. (Everyone)
 - Update the Trello board consistently to reflect the current status of tasks and upcoming priorities. (Everyone)
+- Consider integrating Google Drive or Microsoft 365 for collaborative editing of documents, ensuring adherence to APA formatting guidelines.
 1. Technical Setup Guide:
-- Compile a guide for team members using GitHub with Visual Studio Code for efficient version control and collaboration. (Charles will draft.)
-
-## Specific Requirements and Scenarios:
-
-- The game will actively engage users by challenging them to guess programming-related terms, with hints about their functions in the programming world. Successfully guessing a word triggers a popup explaining the term's significance, adding an educational layer to the game.
-
-## System Specifications:
-
-- Development focuses on Godot 4.2 for game programming and standard web technologies (HTML, CSS, JavaScript) for the website. We advise users to access our product using up-to-date web browsers on devices capable of efficiently running HTML5 content for an optimal experience
+- Compile a guide for team members using GitHub with Visual Studio Code for efficient version control and collaboration. (Charles will draft.)

assignments/week2/Resources.txt

@@ -1,22 +1,20 @@
-### **Resources**
+References
+GitHub. (n.d.). GitHub Learning Lab. Retrieved from https://github.com/apps/github-learning-lab
 
-- **IEEE SRS Template/Reference**: A comprehensive guide and template for creating a Software Requirements Specification document, provided by the Institute of Electrical and Electronics Engineers. This resource is essential for understanding the structure and content needed for a professional SRS. https://ieeexplore.ieee.org/document/278253
-- **GitHub Pages**: The official site for GitHub Pages, which offers the ability to host websites directly from your GitHub repository. A fantastic solution for our project's web hosting needs. https://pages.github.com/
-- **GitHub Pages Documentation**: Detailed documentation on how to set up and manage a GitHub Pages site. This will be invaluable for our team as we deploy our project website. https://docs.github.com/en/pages
-- **GitHub Learning Lab**: An interactive learning platform offered by GitHub. It provides hands-on courses to help our team members get comfortable with GitHub's workflow and features. https://github.com/apps/github-learning-lab
-- **Introduction to GitHub**: A beginner-friendly introduction to GitHub. This resource is perfect for team members new to version control and looking to understand the basics of GitHub operations. https://skills.github.com/
-- **Godot Documentation**: The official documentation for the Godot Engine. It covers everything from basic setup to advanced features, making it a must-have for our game development efforts. [https://skills.github.com/](https://docs.godotengine.org/en/stable/index.html)
+GitHub. (n.d.). GitHub Pages. Retrieved from https://pages.github.com/
 
-### **References**
+GitHub. (n.d.). GitHub Pages Documentation. Retrieved from https://docs.github.com/en/pages
 
-Institute of Electrical and Electronics Engineers. (n.d.). *278253*. IEEE Xplore. Retrieved from https://ieeexplore.ieee.org/document/278253
+GitHub. (n.d.). Introduction to GitHub. Retrieved from https://skills.github.com/
 
-GitHub. (n.d.). *GitHub Pages*. Retrieved from https://pages.github.com/
+Godot Engine. (n.d.). Documentation. Retrieved from https://docs.godotengine.org/en/stable/index.html
 
-GitHub. (n.d.). *GitHub Pages Documentation*. Retrieved from https://docs.github.com/en/pages
+Institute of Electrical and Electronics Engineers. (n.d.). 278253. IEEE Xplore. Retrieved from https://ieeexplore.ieee.org/document/278253
 
-GitHub. (n.d.). *GitHub Learning Lab*. Retrieved from https://github.com/apps/github-learning-lab
+Game Development Document link (GDD): https://github.com/AwaywithCharles/CMSC495-Capstone/blob/main/documentation/GDD.txt
 
-GitHub. (n.d.). *Introduction to GitHub*. Retrieved from https://skills.github.com/
+Minimum Viable Product (MVP): https://github.com/AwaywithCharles/CMSC495-Capstone/blob/main/documentation/MVP.txt
 
-Godot Engine. (n.d.). *Documentation*. Retrieved from https://docs.godotengine.org/en/stable/index.html
+Software Requirements Specifications(SRS): https://github.com/AwaywithCharles/CMSC495-Capstone/blob/main/documentation/SRS.txt
+
+The main repo for the project: https://github.com/AwaywithCharles/CMSC495-Capstone

documentation/GDD.txt

@@ -21,7 +21,7 @@ Our primary audience includes students learning programming, developers interest
 - Successfully guessing the word before the hangman is completed rewards the player with a brief explanation of the term.
 
 ### 2.2 Levels
-The game progresses through increasingly complex programming terms, starting from basic concepts and moving to more advanced terminology.
+The game progresses through increasingly complex programming terms, starting from basic concepts and moving to more advanced terminology. The words can be randomly generated based off of "difficulty" level or value assigned to the word/concept/terminology.
 
 ### 2.3 Ending
 The game ends when players complete a set number of words or fail a certain number of times. Players are encouraged to learn more about programming through external resources provided at the end.

documentation/MVP.txt

@@ -12,7 +12,7 @@ This MVP document outlines the essential features and functionalities that our w
 
 ### Website:
 
-- Responsive design that adapts to desktop and mobile devices.
+- Responsive one-page design that adapts to desktop and mobile devices.
 - Navigation bar to jump between sections of the site.
 - The “Meet the Team” section has brief profiles of each member.
 - The interactive Hangman game is focused on programming concepts.

documentation/SRS.txt

@@ -3,28 +3,29 @@
 ## 1. Introduction
 
 ### 1.1 Purpose
-This document specifies the software requirements for the Web Game Devs project. The project aims to develop a one-page responsive website hosted on GitHub Pages. It will feature an interactive Hangman game that focuses on programming-related words. The project emphasizes collaboration and agile methodologies, utilizing Trello for project management and Discord for team communication. 
+This document specifies the software requirements for the Web Game Devs project. The project aims to develop a responsive website hosted on GitHub Pages. It will feature an interactive Hangman game that incorporates programming-related words. The project emphasizes collaboration and agile methodologies, utilizing Trello for project management and Discord for team communication. 
 
 ### 1.2 Document Conventions
 This document adheres to the IEEE SRS standard format to ensure clarity and consistency.
 
 ### 1.3 Intended Audience and Reading Suggestions
-This SRS is intended for project team members, stakeholders, and future contributors. It guides the development of the website and the game and emphasizes the tools and methodologies employed for effective collaboration. 
+This SRS is intended for project team members and stakeholders. It guides the development of the website and the game that will be embedded in the site. It emphasizes the tools and methodologies employed for effective collaboration. 
 
 ### 1.4 Project Scope
 The project scope encompasses developing a responsive website, creating an interactive Hangman game using Godot 4.2, focusing on programming concepts, and implementing a user-friendly interface for visitors. 
 
 ## 2. Overall Description
 
 ### 2.1 Project Perspective
-This one-page website is a standalone project designed to be hosted on GitHub Pages. It is intended to function across various web browsers and devices, providing a responsive and interactive user experience. The project showcases the team's development skills, integrating an educational Hangman game. To adopt agile practices, it leverages Discord for communication and Trello as a Kanban board. 
+This website is a standalone project designed to be hosted on GitHub Pages. It is intended to function across various web browsers and devices, providing a responsive and interactive user experience. The project showcases the team's development skills, integrating an educational Hangman game. It leverages Discord for communication and Trello as a Kanban board to adopt agile practices. 
 
 ### 2.2 Project Functions
 - A navigation bar for seamless access to the website's sections. 
 - An interactive Hangman game centered around programming terminology. 
-- A "Meet the Team" section with team member profiles. 
+- A "Meet the Team" section with member profiles and information. 
 - Utilization of Discord for continuous team communication. 
 - Adoption of Trello for agile project management and task tracking.
+- There is a possibility of adding additional pages for additional games, time permitting.
 
 ### 2.3 User Classes and Characteristics
 - Casual web visitors interested in playing the Hangman game.
@@ -35,8 +36,10 @@ The website is accessible through modern web browsers like Chrome, Firefox, Safa
 
 ### 2.5 Design and Implementation Constraints
 - The project must be browser-compatible and responsive. 
-- Development will use Godot 4.2 and GDScript, with HTML5 for web exports. 
-- The team will use Discord for communication and Trello for project management, adhering to agile methodologies. 
+- Development for the Game will use Godot 4.2 and GDScript, with HTML5 for web export/embed. 
+- The team will use Discord for communication
+- The team will use Trello for project management, adhering to agile methodologies. 
+- The team will use GitHub for version and source control.
 
 ### 2.6 User Documentation
 The site will provide instructions for gameplay and navigation, along with detailed documentation on GitHub for development insights. 
@@ -50,9 +53,9 @@ High priority. The website's layout and design are crucial for user engagement a
 
 #### 3.1.2 Functional Requirements
 - FR1: The website must feature a responsive design, ensuring usability across devices and screen sizes.
-- FR2: Navigation buttons at the top of the page must allow users to smoothly scroll/jump to the desired section.
-- FR3: The "Meet the Team" section must display team members names, roles, and a short bio.
-- FR4: The game section should embed the Hangman game, allowing users to interact with it directly on the website; a placeholder image could be used initially.
+- FR2: The navigation buttons at the top of the page must allow users to smoothly scroll to the desired section and/or page.
+- FR3: The "Meet the Team" section must display team members' names, roles, and a short bio (a photo is optional).
+- FR4: The game section should embed the Hangman game, allowing users to interact with it directly on the website. Initially, a placeholder image could be used.
 
 ### 3.2 Website Content
 
@@ -83,7 +86,7 @@ Medium priority. Content should be engaging and informative, reflecting the team
 ## 5. Other Nonfunctional Requirements
 
 ### 5.1 Performance Requirements
-- The website should load within 3 seconds on standard broadband connections.
+- The website should load within 3 seconds on standard broadband connections. (GitHub hosting permitting (could be slower if their end is under heavy load))
 
 ### 5.2 Security Requirements
 - Basic security measures to protect against common web vulnerabilities.