diff --git a/docs/requirements/5-30_Cleaner_Workflow/cards1.jpg b/docs/requirements/5-30_Cleaner_Workflow/cards1.jpg deleted file mode 100644 index 714a1d6670..0000000000 Binary files a/docs/requirements/5-30_Cleaner_Workflow/cards1.jpg and /dev/null differ diff --git a/docs/requirements/5-30_Cleaner_Workflow/cards2.jpg b/docs/requirements/5-30_Cleaner_Workflow/cards2.jpg deleted file mode 100644 index 306f3d0b83..0000000000 Binary files a/docs/requirements/5-30_Cleaner_Workflow/cards2.jpg and /dev/null differ diff --git a/docs/requirements/5-30_Cleaner_Workflow/cleaner_workflow_5-30.md b/docs/requirements/5-30_Cleaner_Workflow/cleaner_workflow_5-30.md deleted file mode 100644 index 4bbefadce0..0000000000 --- a/docs/requirements/5-30_Cleaner_Workflow/cleaner_workflow_5-30.md +++ /dev/null @@ -1,66 +0,0 @@ -Questions: - -- [Kinds of Cards](#units-and-exercises) -- [Order of Cards](#card-ordering) -- [Get More out of Each Card](#get-more-from-each-card) -- [Show Progress](#show-progress) -- [When to Stop](#when-to-stop) - -## Tasks, Units and Exercises - -The following cards are discrete actions we came up with. Included are some crazy-8s sketches we did. - -![Card Types 1](./cards1.jpg) ![Card Types 2](./cards2.jpg) - -We have broken cards into a hierarchy which helps facilitate workflow: - -- `Tasks` represent broad, complex changes which affect the entire dataset. -- `Units` break tasks into discrete actions. -- `Exercises` accomplish tasks on manageable subsets of the complete dataset. - -> As of 5-31, these categories have been renamed to `Tools`, `Goals` and `Steps`. - -## Card Ordering - -Our basic consensus for card ordering was this: - -We break the workflow into distinct `tasks` that the cleaner may want to use the app to accomplish. At any point the -user can break out of the current task and switch into a new one, but we orient the UI to suggest they follow our -ordering and finish each task before moving on to the next. - -Each `task` is broken down into `units`. The units are ordered within a task as such: - -- An optional training unit to familiarize the user with the work they will do in that unit. -- The body of units which effect the desired change. -- Optionally merging any duplicates found in the database. -- An optional spot testing unit to evaluate the quality of the data corpus. - -Within each `unit` are one or more `exercises` which break up the `unit` into manageably sized chunks of work. - -The ordering within this structure will be simple to begin. If we have enough time, we can devote time to making more -complex orders based on: - -- Better Workflow -- Qualitative Productivity -- Quantitative Productivity - -Here is a collection of sketches that we took to get to that point. ![Sketches](./sketches.jpg) - -## Get More from Each Card - -> Left for future consideration - -## Show Progress - -Below are the results of brainstorming for ways of showing progress to the user. These eventually led to the UI sketches -shown above. - -![progress1](./progress1.jpg) ![progress2](./progress2.jpg) - -## When to Stop - -If a spot testing unit returns a score above a certain threshold, prompt the user to export his data. - -Beyond that, the user has access to the export function at all times, but will never have it suggested. - - diff --git a/docs/requirements/5-30_Cleaner_Workflow/progress1.jpg b/docs/requirements/5-30_Cleaner_Workflow/progress1.jpg deleted file mode 100644 index f7673890d7..0000000000 Binary files a/docs/requirements/5-30_Cleaner_Workflow/progress1.jpg and /dev/null differ diff --git a/docs/requirements/5-30_Cleaner_Workflow/progress2.jpg b/docs/requirements/5-30_Cleaner_Workflow/progress2.jpg deleted file mode 100644 index 520b533933..0000000000 Binary files a/docs/requirements/5-30_Cleaner_Workflow/progress2.jpg and /dev/null differ diff --git a/docs/requirements/5-30_Cleaner_Workflow/sketches.jpg b/docs/requirements/5-30_Cleaner_Workflow/sketches.jpg deleted file mode 100644 index e95ab93d7a..0000000000 Binary files a/docs/requirements/5-30_Cleaner_Workflow/sketches.jpg and /dev/null differ diff --git a/docs/requirements/RWC Tool Requirements Review.pdf b/docs/requirements/RWC Tool Requirements Review.pdf deleted file mode 100644 index c0e231b61f..0000000000 Binary files a/docs/requirements/RWC Tool Requirements Review.pdf and /dev/null differ diff --git a/docs/requirements/Requirements for RWC Appliance.pdf b/docs/requirements/Requirements for RWC Appliance.pdf deleted file mode 100644 index e5559294ad..0000000000 Binary files a/docs/requirements/Requirements for RWC Appliance.pdf and /dev/null differ diff --git a/docs/requirements/user_tests/user_tests.md b/docs/requirements/user_tests/user_tests.md deleted file mode 100644 index 0eefd04d0a..0000000000 --- a/docs/requirements/user_tests/user_tests.md +++ /dev/null @@ -1,205 +0,0 @@ -# Thursday, June 13 - -We had Beth come in a test the first iteration of the Merge Duplicate Step - -We found 7 improvements: - -- Improve Merge Duplicate Step UX - - - Make next button more visible - - Change direction of card layout to right-to-left - - Make the duplicate suggestions list individually scrollable - - Rename the label of the duplicate suggestions list (was simply "duplicates") - - (possibly, may become unwarranted) Increase the size of the hitbox on the edge of the screen required to scroll - -- Improve Merge Duplicate Card UX - - - Add instructional visuals for stacking exact duplicates - - Visually differentiate instructional cards from word cards - - Reformat Cards - - Display Semantic Domain - - Some way to display multiple glosses, whether interlinearly or in an option. - -- Implement Base Step Progress Indicator - - - The non-functional placeholder was extremely distracting while working. It became a higher priority. - -- Implement Duplicate Stack Sort - - - By default sort by vernacular (possibly allow options to sort by other criteria) - -- Optimize Duplicate Finder - - - Should not hang when getting new list of possible duplicates - - Should return a smaller number of words (8?) - - Should weight vernacular higher - - Should consider transposition - -- Clean Merge Duplicate Step of Debugging Tools - - - Remove Refresh and Clear Database Buttons and Associated Functions - -- Fix Word Card Disappearing when Dropped on Possible Duplicate List - -# Tuesday, June 18 - -- Merge Duplicate UI Tweaks - - - Adjust possible duplicates scroll size based on window height - - Grey out possible duplicates when card selected from list - - Make instructions larger and brighter. Make overly visible. We can make classier later - - Display instruction cards when no cards have been dragged into rows - -- Add Merge Confirmation Dialog - -- Add Stack Display Dialog - - - Allows reordering - - Allows removal from stack - -- Allow Multi-Card Selection - -- Continued Duplicate Finding Improvements - - - Improve quicksearch - - Improve accuracy - - Show loading bar when waiting - -- Tweaks to Proj Creation and Login Screens - - - Should give confirmation when registering a new user - - Should give confirmation when project is created - - Should list required fields - -- Tune Goal Selection Component UX - - - Should not distinguish between single and double clicks - - Should bring goal into focus if clicked on while out of focus - - Should include keyboard controls - -- Work out Browser History - - - The back button is not behaving in a way which makes sense to the user. This should be examined. - - ## Eventually - -- Add Function on Right Click - - - Display card styles - -- Add a Way to Edit Entry - - Flagging - - Merge Confirmation - - Stack View - -The tester also requested an undo button. We determined this was unnecessary. - -# Wednesday, June 26 - -- Tweak Character Inventory - - - Clarify purpose - - Disable 'Add Characters' button until characters have been typed in. - - Save button should give feedback - -- Bugfix - - - Allow cards to be dropped anywhere on wordlist - -- Add Register Dialog - - - User was expecting register to be a separate dialog - -- Add way to Explicitly Return to Goal Navigation - - - User had to ask to figure out how to get back to the goal navigator from a goal - - Separate button - - Hamburger with nav return and logout - -- Rework Duplicate Rows Scrolling - - - User had to scroll to bottom to view new row - - Resize cards based on number of rows - -- Deal with Non-Duplicates in Word List - - - Make title/goal purpose clearer - - Add way for user to acknowledge non-duplicates - - Improve accuracy in duplicate finder - -- Rework Goal Navigation UI - - - Remove decision dimension - - Make horizontal - - Make suggestions selectable and scrollable - - Make cards vertical - -- Greater Granularity of Control in Merge Duplicate Goal - - - Add way to add as plural - - Add way to edit word in merge tool - - Add button to expand stack - -- Improve User Guidance in Merge Duplicate Goal - - - Make stacking mechanic and purpose clearer - - Make dragging mechanic more quickly evident - - Disable right-click for now - -# Wednesday, July 3 - -### Merge Duplicate Goal - -- Minimize Mouse Movement - - - Add keybindings - - Arrow keys to move selected card - - Spacebar/enter? to select card - - Number keys to drop card onto corresponding word - - Possibly move 'save & continue' button - -- Handle Right Click (Still) - - - Select card? - - Show stack? - -- Allow Editing of Card Fields - - - Editable Dropdown/Autocomplete for: - - Vernacular - - Gloss - - Dropdown for: - - Semantic Domain - -- Add Stacking Visuals to New UI - - - Display number of cards in stack - - Display cards in stack on click - - Clarify only one gloss per language per sense - -- Clarify Card Mechanics - - - Add animation to show card has moved, not been deleted (dragndrop library?) - - Make it clearer that cards can be stacked - -- Add Way to Delete Cards? - - "To be Deleted" stack - -### Navigation Component View - -- Don't Append Empty Goals to History - - Check if user did anything within the goal before adding it to the history - -### Create Character Inventory Goal - -- Eliminate Initial Click on 'Add Chars' Button - - - Disable button until field is filled? - - Make buttons invisible until can be used? - - Rename goal more clearly? - -- Move Sliding Buttons to Left Side of Words in Create Char. Inv. - -### Bugfixes - -- Goal History Remains After Logging Out