Skip to content

datawarrior2023/Skee-Ball-League-App

BranchesTags

Repository files navigation

Skee-Ball League App Development 🚀

This repository tracks the full development of a Skee-Ball league management application.
The project utilizes AI tools and simulated team roles to assist with the entire Software Development Life Cycle (SDLC).

Business Name

"AI Edge Solutions"

  • A fictional tech solutions company that develops applications for niche markets and small businesses, like Skee-Ball leagues.

Project Overview

This application is being built to replace the manual Google Sheets tracking system for a local Skee-Ball league.
It will streamline team management, score input, leaderboards, and match scheduling.

The development process involves:

  1. Requirements Gathering
  2. Planning and Design
  3. Development
  4. Testing
  5. Deployment and Feedback

Simulated team members will fulfill key project roles (Business Analyst, Developer, etc.), with AI-generated personas guiding each step.

Simulated Roles

Team Members

The simulated team from AI Edge Solutions consists of:

  1. Emily Hart (Business Analyst)
  2. James Lee (Project Manager)
  3. Sarah Cohen (UX/UI Designer)
  4. Mike Ramirez (Full Stack Developer)
  5. Chloe Nguyen (QA Tester)

Details of each team member can be found in 00_Documentation/Team_Description.md.

Directory Structure

📦 skee-ball-league-app/              # Root directory for the Skee-Ball League Management Application
│
├── 00_Documentation/                 # Documentation for the project
│   ├── Team_Description.md           # Descriptions of team members and roles TEMPLATE ADDED
│   ├── Business_Overview.md          # AI Edge Solutions business overview TEMPLATE ADDED
│   ├── AI_Notes_Summaries/           # AI chat logs, summaries, and key insights
│   │   ├── AI_Notes_Session1.md      # Notes from early brainstorming sessions
│   │   ├── AI_Notes_Session2.md      # Notes from later AI-assisted sessions
│   │   └── Optimized_Prompts.md      # Optimized prompts and relevant responses TEMPLATE ADDED
│   └── Process_Documentation.md      # Overview of the process being followed TEMPLATE ADDED
│
├── 01_Requirements/                  # Requirements gathering and planning phase
│   ├── BRD_Requirements.md           # Business Requirements Document TEMPLATE ADDED
│   ├── User_Stories.md               # List of user stories TEMPLATE ADDED
│   ├── Interview_Guide.md            # Stakeholder interview template TEMPLATE ADDED
│   ├── Feature_Priority_Matrix.md    # Feature prioritization document TEMPLATE ADDED
│   └── Feature_Priority_Matrix.xlsx  # Prioritization matrix in Excel format
│
├── 02_Planning/                      # Planning phase documents
│   ├── Project_Plan.md               # High-level project plan TEMPLATE ADDED
│   ├── Task_Timeline.xlsx            # Task, timeline, and milestone tracker
│   └── Risk_Management.md            # Potential risks and mitigations TEMPLATE ADDED
│
├── 03_Design/                        # Design assets and outlines
│   ├── UX_UI_Wireframes/             # Wireframes and mockups
│   │   ├── Wireframe_Outline.md      # Wireframe structure and key screens TEMPLATE ADDED
│   │   ├── wireframe_homepage.png    # Wireframe for homepage
│   │   └── wireframe_team_dashboard.png # Wireframe for team dashboard
│   ├── User_Flow_Diagrams/           # User interaction and navigation flows
│   │   └── User_Flow_Diagram.md      # User flow diagrams for the application TEMPLATE ADDED
│   └── Architecture_Diagram.md       # System architecture diagram TEMPLATE ADDED
│
├── 04_Development/                   # Development phase structure
│   ├── frontend/                     # Frontend code (React, HTML/CSS)
│   │   └── frontend.md               # Notes and instructions for frontend development
│   ├── backend/                      # Backend code (Node.js, APIs)
│   │   └── backend.md                # Notes and instructions for backend development
│   ├── database/                     # Database scripts/schema
│   │   └── database.md               # Notes for database setup
│   ├── dev_logs/                     # Development logs and notes
│   │   └── dev_logs.md               # Logs for tracking development progress
│   ├── Feature_Dev_Checklist.md      # Checklist for feature development TEMPLATE ADDED
│   └── Architecture_Diagram.md       # System architecture diagram TEMPLATE ADDED
│
├── 05_Testing/                       # Testing phase documents
│   ├── Bug_Tracking_Log.xlsx         # Log for tracking bugs during testing
│   ├── Test_Cases.md                 # Test cases for functionality validation TEMPLATE ADDED
│   ├── Testing_Checklist.md          # Checklist to track all testing activities TEMPLATE ADDED
│   └── Testing_Report.md             # Final report summarizing testing results
│
├── 06_Deployment/                    # Deployment and post-deployment phase
│   ├── Deployment_Checklist.md       # Checklist for deployment tasks TEMPLATE ADDED
│   ├── Feedback_Form.md              # Form for collecting user feedback TEMPLATE ADDED
│   └── Post-Deployment-Log.md        # Log of results, issues, and observations TEMPLATE ADDED
│
├── .gitignore                        # Specifies files to ignore in version control
└── README.md                         # Overview of the project and its structure

Development Process

This project follows an Agile-inspired iterative workflow:

  1. Define Requirements → Document user stories and features.
  2. Plan → Break work into tasks and create timelines.
  3. Design → UX/UI wireframes and architecture diagrams.
  4. Develop → Code features incrementally, starting with the MVP.
  5. Test → Test core features and track bugs.
  6. Deploy → Deploy for user feedback and iterate.

Technology Stack

  • Frontend: React.js (or similar library)
  • Backend: Node.js with Express
  • Database: PostgreSQL
  • Version Control: Git/GitHub
  • Tools: Lucidchart (design), Excel/Google Sheets (tracking)

How to Contribute

For now, this is a personal learning project. If you're here to follow along or learn, feel free to explore!

Status

  • Current Stage: Requirements Gathering
  • Next Step: Stakeholder Interviews and BRD Creation

AI Resources

AI-assisted notes, chats, and optimized prompts are stored in:

  • 00_Documentation/AI_Notes_Summaries/

You can refer to Optimized_Prompts.md for reusable prompts and their relevant responses.

Created and Maintained by

Explanation of Directory

Each folder corresponds to a major phase of the workflow:

  1. 01_Requirements: All requirement documents, including templates and feature prioritization.
  2. 02_Planning: Detailed project plan, timelines, and risk management.
  3. 03_Design: Wireframes, user flows, and architecture diagrams for clarity.
  4. 04_Development: All source code for frontend, backend, and database logic.
  5. 05_Testing: Test cases, bug logs, and testing summaries.
  6. 06_Deployment: Deployment steps, feedback forms, and post-deployment notes.

Guide for step-by-step through filling out all documents, here is the recommended order with clear reasoning:

1. Clarify Project Scope and Goals

  • Why First: This sets the foundation for the entire project. Clarifying the scope, target users, and goals ensures everything aligns from the start.
  • Related Files:
    • Business_Overview.md
    • BRD_Requirements.md

2. Document Business Overview

  • Why Next: A well-documented business overview ensures you understand the challenges, goals, stakeholders, and metrics for success.
  • Related Files:
    • Business_Overview.md

3. Gather and Define Requirements

  • Why Next: Clearly defining features and user stories is essential for planning and prioritizing development.
  • Files to Complete:
    • BRD_Requirements.md
    • User_Stories.md
    • Feature_Priority_Matrix.md

4. Plan the Project

  • Why: Once requirements are defined, outline the project plan, milestones, and tasks.
  • Files to Complete:
    • Project_Plan.md
    • Risk_Management.md
    • Task_Timeline.md

5. Create Design Documents

  • Why: Design files (wireframes and user flows) are essential for visualizing and validating the application layout and structure.
  • Files to Complete:
    • Wireframe_Outline.md
    • wireframe_homepage.png
    • wireframe_team_dashboard.png
    • User_Flow_Diagram.md
    • Architecture_Diagram.md

6. Prepare for Development

  • Why: Finalize development processes and log structures to ensure clarity during coding.
  • Files to Complete:
    • Feature_Dev_Checklist.md
    • Architecture_Diagram.md

7. Testing Preparation

  • Why: Before coding, prepare test cases to ensure coverage of features and edge cases.
  • Files to Complete:
    • Test_Cases.md

8. Execute Development

  • Begin building the backend, frontend, and database while updating dev logs.
  • Files to use and update during development:
    • backend/backend.md
    • frontend/frontend.md
    • database/database.md
    • dev_logs/dev_logs.md

9. Test and Validate

  • Execute the tests and document findings.
  • Files to Complete:
    • Testing_Checklist.md
    • Testing_Report.md
    • Bug_Tracking_Log.xlsx

10. Prepare for Deployment

  • Finalize deployment steps, address feedback, and collect stakeholder input.
  • Files to Complete:
    • Deployment_Checklist.md
    • Feedback_Form.md
    • Post-Deployment-Log.md

11. AI Agent Prompts

  • Add and validate AI Agent Prompts in each document for refinement and clarity.

About

Developing and building an application to run a skee-ball league

Resources

Readme
Activity

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published