Skip to content

Requirement Specification

Jump to bottom
Isabel Giang edited this page Apr 19, 2017 · 51 revisions

General Requirements

  • Users CAN NOT make accounts, and their data WILL NOT be recorded or stored
  • Users must have a clear idea of the purpose and scope of Level - particularly that it does not support accounts or character data storage
  • All information provided to the users must be correct, or as correct as official sources: Roll20, D&D Player’s Handbook
  • Users must be provided a clear and concise instructions for how to follow the prescribed leveling up process, which must be broken into the manageable elements already separated in the book (D&D Player’s Handbook 5th Edition)

Homepage

Class Selection

  • Users must be able to find and select the class for their search query
  • Users must be able to deselect the class for their search query
  • Available classes must be sorted in increasing alphabetical order

Level Selection

  • Users must be able to find and select the level for their search query
  • Users must be able to deselect the level for their search query
  • Levels must be sorted in ascending order

Search Start

  • Users must be able to begin the level-up process in some way
  • Users must only be able to navigate to the a new page if both class and level have been selected

Reference Pop-Up Window

  • All D&D and Gaming ‘Jargon Keywords’ - in other words, a concept, phrase or word that has a particular meaning or function within the Dungeons & Dragons universe that requires additional contextual information for novices or beginners - must have bold, green font to indicate that it is jargon and be clickable
  • Clicking on jargon words must bring another section to view.
  • This view must accurately explain the concept of the jargon word in question
  • This view must explicitly show where the user should look on their own character sheet to understand the jargon word in the context of their character sheet
  • This view must be able to close the Reference Pop-Up Window easily, after which they are back on the screen where they clicked on the green word.

Steps Overview

Organization

  • Steps must be ordered as follows:
    • Simple Increases
    • Features
      • Action Features (when applicable)
      • Enhance Features (when applicable)
      • Shape Features (when applicable)
      • Update Features (when applicable)
    • Magic
      • Increase Spell Slots (when applicable)
      • Learn Spells, Cantrips, Incantations (when applicable)

General Design

  • Subheaders
    • On the top of each step page, users must be shown the Class and Level for which they are iterating through a level-up proces.
    • On the top of each step page, users must be shown which Step they are on, both number and title, and the purpose of the Step, in terms of what information it provides (Ex: Step 1, Increase Hit Points)
  • Next and Back Buttons
    • There must be a next button at the bottom right section of the page
    • Upon clicking the next button, users must be taken to the next step, unless this step is the last (Step 1 to Step 2 / last step to Completed Page)
    • There must be a back button at the bottom left section of the page
    • Upon clicking the back button, users must be taken to the previous step, unless this step is the first (Step 4 to Step 3 / Step 1 to Homepage)
  • Progress Bar
    • There must be a progress bar at the bottom of the page, filled to A/B, where A is the current step number, and B is the calculated number of steps this process includes for this specific Class and Level.

Simple Increases

Increase Hit Points

  • User's must be provided with correct, simple Hit Die instructions
  • (Fighter, Step 1: roll a 1d10, then add your character’s constitution modifier)
  • Users must be see a visual representation of the correct dice type for their character class (Fighter: illustration of a 10-sided dice)

Proficiency

  • Users must be provided with a Step that instructs them to increase their proficiency to +3 at Level 5, +4 at Level 9, +5 at Level 13, and +6 at Level 17

Class Specific Increases

  • Barbarians must be provided with a specific Step to increase Rage and/or Rage Damage at Levels specified by the rules
  • Monks must be provided with specific Steps to increase Martial Arts, Ki Points, and Unarmored Movement at Levels specified by the rules
  • Rogues must be provided with a specific Step to increase Sneak Attack at Levels specified by the rules
  • Sorcerers must be provided with a specific Step to increase Sorcery Points at Levels specified by the rules

Features

  • Users must be provided with all the features for their Level & Class, and the features for no other Levels and/or Classes.
  • Users must be provided with Steps that provide instructions on how to add new or adjust old features for their character, as specified by the rules for each specific Class and Level.
  • For updating existing Features, users must be shown the correct information for the given level and class. (Change Song of Rest from 1d6 at Level 2 to 1d8 at Level 9)

Organization

  • Each Feature must have its own Step.
  • If a Feature has functions that are separate (in the sense that their functionality is not related to each other), this separation will be visually indicated by breaking up the container that hods the feature into multiple Steps.

Formatting

  • If a Feature includes displaying a list, each choice must be shown as a bullet point to avoid implying to the user that they must indicate their choices on Level's interface
  • If Feature choices are long (too many and/or too lengthy to fit comfortably on a mobile web page), choices must be labeled, included description must be removed entirely, then be expandable in a Reference Pop-Up Window for full detail.

Magic

  • If a character is gaining magic, or spellcasting, there must be a prominent region which shows their Spell Save Difficulty Class and their Spell Attack Modifier, with lots of Jargon Keywords
  • Users must be informed as to which spell slots they have just gained, and have the ability to see what their total spell slots are.
  • User's must be informed as to how many spells they are able to learn
  • If the user’s character has the feature to replace existing spell, they must be prompted that they have that option.
  • All possible spells must be shown, for their class and level (only from the Player’s Handbook)
  • Spells must be expandable to show detailed effect, properties, constraints; all relevant and correct information as specified in the Handbook
  • Once expanded to the Spell page, users must be able to return to the previous Step page with a back button.

Organization

  • Spells must be sorted by their spell level
  • Under spell level, spells must be in alphabetical order

Completed Page

  • Users must be given a visual indication that level-up is complete (“Congratulations! You are now a Level 5 Wizard”)
  • Users must be able to return to the previous Step page with a back button
  • Users must be able to iterate through the Level process again if desired, via a button on the bottom

Clone this wiki locally