Technical Proposal

Developer Problem
1. Data
  1. Data Source Options - Exploring Data Sets (Please Note: Pros and Cons in document, not Mind Map)
    1. Data Source Option 1 - Pets Database
      1. Interesting
        Not all Pets have a Level 1 (2 or 3) ability, because they are summoned, meaning they only have one ability that is activated upon summoning.
        The Pet with the highest base Attack is the Leopard (at 10 points).
      2. Potential data cleaning
        Removing the "source", "commit" and "unicodeCodePoint" fields and replacing them with a simple image field (as users don't need access to these to gain basic Pet details).
        Find the correct details on the baseAttack and baseHealth of the Pets that are summoned so that they are integer type.
    2. Data Source Option 2 - Food Database
      1. Interesting
        All Food images are sourced from "twemoji", except for the "Sleeping Pill" food (sourced from "fxemoji"). It is also interesting that the Sleeping Pill is the only non-food item in this database.
        All Foods either have both an attack_amount and a defense_amount, or neither.
      2. Potential data cleaning
        Removing the source and commit columns, and just keeping the unicodeCodePoint images to display to the user.
        Finding (if applicable), the tier level for Milk to make the whole field "integer" data type, instead of "varchar".
    3. Data Source Option 3 - Toys Database
      1. Interesting
        The "TierMax" value ranges from 2-6, plus another value option of 2147483647. This number is called the "Mersenne Prime", and, for signed 32-bit integers, is the largest value a field can hold. This is simply a way of signifying that these Toys do not have a maximum Tier value.
        Every value in the "Packs" column is "[]"; an empty array.
      2. Potential data cleaning
        The columns "Type", "Packs" and "Rollable" are contain values that are the same throughout all fields ("1", "[]" and "TRUE", respectively). This may not be necessary to display to users if there is no variation.
        Using a composite key of the ID and the Ability_Level to ensure that the correct type of each Toy is being referenced.
  2. Data Storage and Retrieval
    1. SQLite Database: Pets Database (pets.db)
    2. Create Table Statement used: CREATE TABLE Pets ( id varchar(255) PRIMARY KEY UNIQUE NOT NULL, name varchar(255) UNIQUE NOT NULL, baseAttack int(3) NOT NULL, baseHealth int(3) NOT NULL, tier int(3) NOT NULL, Level_1_Ability varchar(255) NOT NULL, Level_2_Ability varchar(255) NOT NULL, Level_3_Ability varchar(255) NOT NULL, Image_URL varchar(255) UNIQUE NOT NULL );
2. Coding Environment
  1. Development Tools and Available Resources
    1. Thonny
      1. Used to create Python functions for the web application, and link the HTML templates and SQL Database to the web app.
    2. QLearn
      1. Provides templates and learning resources on how to complete sections of the task.
    3. QCAA
      1. Provides exemplar and confirmed government definitions and learning resources.
    4. Notepad++
      1. Used to program the HTML templates that structure the web app.
    5. sqlite3.exe
      1. Used to access the data in a database format. Can create tables and select data to be shown, overall storing the SAP data in an easy-to-use/retrieve format.
  2. Key Algorithms
    1. Search
      1. Users can type in keywords like the pets' name or the food item, and have a list of most relevant results come up (or maybe the individual page of the sprite with the exact name of the search request).
    2. Hyperlinks
      1. When the users are browsing each page of sprites, they can click on the image/name and are taken to the individual page.
3. User Interface
  1. User Interface Components
    1. Menu Bar and Categories
      1. Possibly organising the different types of sprites into categories and storing them on separate pages (accessible via the headings) ensures that the webpage is not too cluttered or overwhelming for users, encouraging them to use the web application again.
    2. Images
      1. Allow the users to have a visual representation of each gameplay sprite (e.g. Pet). Images also allow for faster navigation as users can don't need to read the text to find the sprite they are looking for.
    3. Buttons and Links
      1. Take users from the main page that lists all Pets/Food/Toys to the individual pages that contain more detail.
    4. Text
      1. Used to relay information to users (like Pet statistics). Text can be differentiated by font sizes, colours and text decorations.
  2. Usability Principles (with Elements and Principles of Design and Communication in Brackets) (see the Definitions table for definitions of the Principles)
    1. Safety
      1. Removing any possibility for users to enter or modify information (such as the SAP data, or their personal details), so they cannot make any validation errors or accidentally alter important details.
    2. Learnability
      1. Using a repetitive method of presenting the data on the main page and individual pages (Repetition and Harmony), so that the users know what to expect.
      2. Maybe use symbols to represent the values for Attack and Health, so the users' eye is immediately drawn to that when they search for those statistics.
    3. Accessibility
      1. Having large, clear text (Contrast and Scale/Proportion) so that more users can read the information.
      2. The ability for users to tab through the website for navigation (Shape and Line are used when the user is "focussed" on one button/hyperlink)
      3. The flexibility between mobile devices (Space, Balance, Alignment, Hierarchy and Harmony) - so that users can access this web application on any device and the information is not cut off or unaligned.
    4. Effectiveness
      1. The basic level abilities of each data sprite are given in an easy-to-read format so that users only have to glance at the web app before going back to their (possibly competitive) SAP game.
    5. Utility
      1. A search bar is at the top of the main page and individual pages (in the menu bar), so that the user can search for Pets at any time.
  3. Possible Features
    1. Dark Mode
      1. Being able to change the background colour of the web application allows users with sensitive eyesight or who like to play at nighttime to continue enjoying the website and SAP.
    2. Mobile friendliness
      1. Even though user persona, Sean, prefers to access statistics on his computer, having a web application that's responsive to different devices would encourage more users to use the app, as they can access it in more places, anytime.
Task Requirements
1. Existing Solutions
  1. Solution 1
    1. Pros
      1. Provides images with the category menu - users know what they are browsing
      2. Signed-in users can make changes to pages and collaboraote in discussions in forums - allows the correction of errors
      3. In individual pages, a table represents the Level Abilities of Pets.
    2. Cons
      1. Too many links and categories - could be overwhelming
      2. Too much plain text - surplus information could waste the users' time
      3. Small font and bright orange hyperlinks are very hard-to-read and limit the possibilities for accessibility to users.
  2. Solution 2
    1. Pros
      1. Provides links to API data and the repository on GitHub (allowing users to make comments, report errors and have access to the data for their own programming benefits)
      2. Visual images (emojis) are used to represent the tier number, attack and health values - users can quickly identify that data due to the eye-catching emojis
      3. Users can search for their desired Pet/Food item
    2. Cons
      1. On individual pages, the font size is much smaller than the main page - hard for users to quickly read
      2. All data is grouped together - users have to search through a lot of information to find what they want
      3. Each tier isn't collapsable, so the user might have to scroll a lot to reach the bottom - very time-consuming
2. Constraints and Limitations
  1. Coding Environment
    1. Distractions to the general working environment could limit productivity in classtime.
    2. Before continuing with the assignment, it must be ensured that all necessary programming applications (like Notepad++ and Thonny) are downloaded, and that all necessary packages are downloaded to Thonny. The correct software to run the program must be downloaded.
  2. Skills
    1. Working with new databases could create problems due to the necessary inclusion of new columns in each dataset.
    2. Limited knowledge of the SAP game could reduce the quality of the final web application as the general rules, and thus most suitable format of a factual web application, are not clearly known.
    3. General programming skills in languages like Python, HTML, CSS, SQL and possibly JavaScript may be limited for this type of task.
  3. Time
    1. With only 3hrs (minus some lessons) provided each week for teacher consultation and class work, lots of time will be put into this assignment at home. The minimal classtime could become a constraint to the assignment.
3. Prescribed Criteria
  1. The web application must use a minimum of one external data source.
    1. The web application must link to the “Pets” Database.
    2. The file type of the data must be .db.
  2. The web application must display the data from a minimum of one external data source.
    1. The web application must display data from the “Pets” Database.
    2. The web application must use HTML and CSS programming to display web application elements.
  3. The web application must incorporate the use of Usability Principles.
    1. Incorporate the Principle of Accessibility by increasing visibility of font and images through size and contrast.
    2. Incorporate the Principle of Safety by minimising the ability for users to enter data.
    3. Incorporate the Principle of Learnability by using a consistent page layout, so that the users know what to expect.
4. Self-Determined Criteria
  1. The web application should contain a search bar on at least one page.
    1. The web application should allow users to search the Pets dataset by Pet name.
    2. The web application should provide error messages if the user inputs data incorrectly.
    3. The web application should take the user directly to the individual Pet page if they search with the search bar.
  2. The web application should display the basic details of Pets in an easy-to-read format.
    1. All level abilities (1, 2, 3) should be displayed directly on the page, without the user having to click anything, to be read quickly.
    2. Each individual page should display an image of the Pet.
5. Details (Source: IA2 Digital Solutions Task Sheet 2024 Document)
  1. Context
    1. Super Auto Pets - collect and combine animals - create powerful synergies and strategies
    2. "charming visuals and humorous atmosphere" - for casual and competitive gamers
    3. Ranking systems - animal battle arena
  2. Task
    1. "Develop a prototype web application"
    2. Programmed and user-interface components
    3. "external data components and data structures"
    4. "evaluation against criteria"
User Problem
1. User Persona
  1. User Persona 1 - Sophie Hawthorne
    1. Wants
      1. To be better at SAP
      2. Search the names of SAP animals
    2. Needs
      1. Easy-to-use platform that shows statistics of SAP animals (Source: IA2 Technical Proposal 2024 Document)
      2. Access to information quickly when competing in SAP
    3. Details
      1. Age: 29
      2. Location: Brisbane
      3. Occupation: Zoo Keeper
      4. Interests: Casual Gaming
      5. Frustrations: poor memory and forgetting stats (Source: IA2 Technical Proposal 2024 Document)
  2. User Persona 2 - Sean Thornberry
    1. Wants
      1. To be better at SAP
      2. Aesthetically pleasing SAP website that shows all toys or food data (Source: IA2 Technical Proposal 2024 Document)
      3. Platform to display well on Desktop Computer screen (so he can play SAP on his mobile phone) (Source: IA2 Technical Proposal Document 2024)
    2. Needs
      1. An application that is easy-to-use and displays SAP information
    3. Details
      1. Age: 65
      2. Location: Brisbane
      3. Occupation: Retired
      4. Interests: Reducing the possibility of early onset Alzheimer's through gaming (Source: IA2 Technical Proposal 2024 Document)
      5. Frustrations: Trying to read the stats on his phone - his eyesight is bad and the font is too small (Source: IA2 Technical Proposal 2024 Document)
Impacts
1. Economic
  1. Positive for individuals
    1. This web application is most likely going to be free, or at a low cost, meaning that players don't need to pay a lot to quickly find information or statistics.
  2. Positive for creator of SAP
    1. This web application is separate from Team Wood Games (developer of SAP), so it won't cost them for it to be developed. Additionally, providing extra information that encourages gameplay will support Team Wood Games, and boost their profits and overall game purchases.
  3. Negative for business with a paid option
    1. This digital solution negatively impacts any other business who develops a similar type of web application, but sells it for a greater cost. This is because users are more likely to use the free option (this web application), limiting the amount of purchases that competing business might make.
2. Personal
  1. Skill Improvement
    1. Users are able to quickly find the solutions to any mistakes or errors they made while playing the game by searching for sprite statistics, meaning that they can improve faster and become a better player, easier.
  2. Availability
    1. Having an easy-to-access web application that is categorised in an organised manner and easy to navigate would save players lots of time. This is especially helpful during a competitive game, when there is no time to individually search each available pet/toy/food statistic.
3. Social
  1. Social cohesion and collaboration
    1. Users are more likely to collaborate and talk to each other about SAP if they can connect over and share an additional platform related to gameplay.
  2. Multi-platform
    1. Users are more likely to enjoy SAP and find it easier to play if there is a factual website that gives them helpful information.
  3. Valid and Public Information
    1. Users would be willing to trust the site because the information is public (so they don't have to enter any personal details) and the data is valid and supplied by the game provider.

Next up

Technical Proposal

Description

Resource summary

Media attachments

Similar

	Created by Rebbecca Stanley about 2 years ago