Documentation

I. Introduction

A. Overview of the web application

This web application, written and documented by me, Henry Osterweis, is a spin-off of the game Boggle, Wordle, and Word search. The title "Squrbble" is temporary. It is my final project for NYU Tandon DM-UY 2193.

B. Purpose and audience of the documentation

The purpose of the documentation is to tell the story of my process developing the site.


II. Getting Started

A. System requirements

A modern web browser, such as Chrome or Safari.

B. Installation instructions

N/A.


III. User Interface

A. Navigation and layout

The site consists of two pages, index.js and docs.js. Index.js is the home page which is shown on the initial visit. Navigation to docs.js is through the link "Documentation" at the bottom of the page. The site structure is purposely simple to drive attention to the game while keeping the user experience smooth and enjoyable.

B. Functionalities of each page

Index.js hosts the game. Docs.js hosts the documentation.


IV. Gameplay

A. Basic rules

Create words by combining letters. Click on cells to connect letters then submit the word using the button above the board. If the word is valid according to the English dictionary, the word will be added to your answer list and appear on the sides of the board. Keep finding new words until you have collected a total of twelve words.

B. Winning

Collect the most total points and get the highest score to win.


V. Support and Maintenance

A. User testing and feedback

During the development of the game I received various comments from users testing the application. Feedback included the following: making sure there is at least one playable word on every board; adding Scrable multiplier tiles with color; creating a leaderboard of scores.

B. Known bugs / To-do list

Known bugs currently include the following: the score counter does not remove points awarded for letters in an invalid word; more than twelve words can be submitted; cells connected by corners can be consecutively selected. These bugs will be fixed in the future; the following changes will be implemented: the suggestions from user feedback; a proper endgame screen, mousedown and mousemove functionality to replace clicking and submitting words with a button.

C. Reading source code

The source code includes comments to help step through and understand each function. Report any inconsistencies or mistakes to hpo2004@nyu.edu.


VI. Conclusion

This is the documentation for my DM-UY 2193 final project. Contact me at hpo2004@nyu.edu.


~ This page was last updated by Henry Osterweis on Sunday May 7, 2023.