From 5386098f4e57970d145b4e01f513dbfedf4d6652 Mon Sep 17 00:00:00 2001 From: Chuck Scott Date: Tue, 15 Oct 2019 14:42:18 -0400 Subject: [PATCH] Moved all admin redesign files into separate folder and updated various files. --- AdminRedesign/GLM-Associate-Admin-Flow.txt | 177 ++++++++++++++++++ .../GLM-Associate-Admin-Requests.txt | 0 AdminRedesign/GLM-Associate-Stories.txt | 56 ++++++ GLM-Associate-Admin-Flow.txt | 154 --------------- 4 files changed, 233 insertions(+), 154 deletions(-) create mode 100644 AdminRedesign/GLM-Associate-Admin-Flow.txt rename GLM-Associate-Admin-Requests.txt => AdminRedesign/GLM-Associate-Admin-Requests.txt (100%) create mode 100644 AdminRedesign/GLM-Associate-Stories.txt delete mode 100644 GLM-Associate-Admin-Flow.txt diff --git a/AdminRedesign/GLM-Associate-Admin-Flow.txt b/AdminRedesign/GLM-Associate-Admin-Flow.txt new file mode 100644 index 0000000..eb7aa33 --- /dev/null +++ b/AdminRedesign/GLM-Associate-Admin-Flow.txt @@ -0,0 +1,177 @@ + +INSTRUCTIONS + +This document is intended to develop into a detailed specification for the admin area. It should +evolve from a rough strategic document to that fully detailed specification. It's OK to include +items that generally describe what we want and how that will work and be applied then work out +the details over time. + +Please add any comments or suggestions for changes rather than just changing things here. These +will be considered and either integrated into the outline, have added comments, or be deleted. + +Use the "General Comments" section for things that are not specific to a particular area below that. + +Comments in specific areas should be indented from the item you're commenting on. Precede all of +your comments with your name. Added comments on someone else's comment should be indented further. +For example... + + * Some item already in the outline + Chuck: This is my suggested change + Steve: I tend to agree with this change but we might need to consider ... + Laury: Can we move this to ... + + +== Changelog == += 10/15/19 - Chuck = +* Restructured objectives +* Reduced some initial flow specifics. +* Created "GLM-Associate-Stories.txt" file <<<<< See This file!!! + + +ADMIN DESIGN OBJECTIVES +------------------------ + + * Enable users to work the way that makes the most sense to them + * Let individual users select what's most important for themselves + * Perhaps permit changing order of widgets or whatever + * Let individual users avoid things of limited or no interest to themselves + * Hide widgets or certain widget content + * Give users a simple way to find things + * User "help" resources + * General browseable help information + * Context sensitive help + * Method to display context sensitive help is the same everywhere + * Searcheable help + * User must be able to directly return to what they were doing before accessing help + * Help information should have hot-links to other relevant information + * Include definitions directly into help information (clickable?) + * If possible, include an overall diagram of how all things in GLM Associate are related + * Users should be able to simplify repetative groups of tasks - Wizards? + * A "Wizard" is a semi-automated series of steps for completing a multi-step task + * When a Wizard is selected it should show that's it's active on the user interface and show the current step + * Users should be able to select the next or previous step + * For each step the Wizard takes the user to the relevant area to complete that step + * The Wizard should show a description (overlay?) for each step it presents to the user + * User should be able to turn on/off the step descriptions at any point + * Should probably be able to keep certain references needed for additional steps + i.e. the member ID associated with an Event that is being created. + * There should be a set of pre-defined Wizards for common things that take more than one step to complete + + * Provide flexible and easy to understand user interface (ui) + * Simple overview + * Things that need attention should be obvious and easy to access + * Direct and simple access to various areas of interest to the user + * Highly standardized elements for doing common things + Things that appear often, such as Add, Delete, Relevant Settings + * Highly standardized user interface + * Things that are similar must always work the same throughout + * Similar things in different areas work the same and are found in consistent locations + + * Organize to be consistent with how users look at what they want to get done + * This may or may not be an organization based on a division of data by "Add-On" + * Let users hide things they don't normally need, but provide easy access to them if they did + * Let users define a common flow of tasks for themselves + * Perhaps let them build custom "Wizards" that walk themselve through common things they do + * If there's management or settings related to where they are, that should be directly accessible + * The user should be able to go directly back to what they were doing when done + + * Streamline common tasks - Possibly offer "wizards" for certain things. + * Wizards should use the actual items that the person has to work with normally to do the pieces of the general task + i.e. Required steps to create an Event or setup Registrations. + + * Fast development, easy updates and support + * Use of standard ui elements + * ui elements should be "hierarchical" + * Should build upon themselves to create the content + * No ui element should be a complete or complex interface + * Think of things that might contain other ui elements + * Think of low-level ui elements that are the building blocks of a more complex interface + * View should define the user interface + * No ui elements at all in models + * Views should define the flow of the admin area from the top down + + * Keep users within a familiar context so they know where they are and don't get lost + * Users should not have to "find" they're way back to where they came from + * Users should be able to easily access a different set of information withough loosing their current context + * i.e. If a user has something selected to review and they need to do something unrelated, they should be able + to go directly back to what they selected. + + + +ADMIN FLOW SPECIFICS +-------------------- + +*** Things from here down are initial thoughts, not yet an actual plan *** + +* User Interface Components - Standardize + + * Menu + * Navigation / Headers to identify where the user is working + * Widgets - Main dashboard - elsewhere??? + * Temporary expanded info and edit possible features + * Expanding region + * Pop-up or overlay + * Sliders + * ??? + +* GLMA Menu + + * Consider removing all left-hand menu items other than "GLM Associate" + +* Main Dashboard + + Main dashboard should provide the following. + * Access to general Help information - Optionally entire help document. + * Display of relevant status (limited - any?) + * Notification of, and access to, things that need attention + * Access to settings associated with each Add-On widget + * Access to main lists of information in limited format + * Filters and sorting for these lists + * Easy access to expanded info and editing of entries in these lists + * Direct access to the associated add-on Dashboard + * Easy return to a focused widget after linking off to a relevant add-on page or + after use of an edit or info pop-up or slider + + Widgets + + * GLM Associate brief status - Widget + * Access to related Help information + * Anything general to GLMA that needs attention + * Access to Global settings and management options + * Highlight if required information not completed - i.e. no categories or cities + + * Widgets for specific areas of information - Not necessarily organized by Add-On + * Access to related Help information + * Relevant general status (limited) + * Contains brief summary information of things that need attention or flag that something needs attention + * Easy access to edit/update items needing attention and easy return to this widget + * Current active items of interest - i.e. currently open registrations + * Quick access to detail/edit of active items and easy return to this widget + * Direct access to entries in significant lists - i.e. members + * Quick access to detail/edit of list items and easy return to this widget + +* Individual Add-On pages (including members) - Consider not having "Pages" per add-on. + + + +--------------------- +Anthony T : 10-9-2019 - Thanks for this. +--------------------- +* Previous GLMA Admin Revamp Flow + * Basic Flow: ( Single Page Application coordinated mostly with a routed drawer ) + * Dashboard --> widgets --> widget --> open drawer to perform an action (add new entity, edit profile, change settings pertaining to the relevent add-on etc.) + * List View: + * Add New Entity --> opens drawer to present the new entity form + * Selecting List Item --> opens drawer to present the edit / manage entity form(s) + * Settings Button --> opens drawer to present the settings / management options for the relevent section / add-on + * Filters --> filters manipulate the list without page reload + + * Main menu item ( GLM Associate ) leads to the Widget Dashboard + * Entity Name (Members, Events etc. ) leads to the List / Management view for that add-on. (members list, events list etc.) + + * Widget Dashboard : + * wigdets contained basic lists and filters for pending or actionable items related to an add-on + * widgets did not permit management of the add-on internally but routed to the proper section , primarily the drawer which was routed internally + + + diff --git a/GLM-Associate-Admin-Requests.txt b/AdminRedesign/GLM-Associate-Admin-Requests.txt similarity index 100% rename from GLM-Associate-Admin-Requests.txt rename to AdminRedesign/GLM-Associate-Admin-Requests.txt diff --git a/AdminRedesign/GLM-Associate-Stories.txt b/AdminRedesign/GLM-Associate-Stories.txt new file mode 100644 index 0000000..258d5ff --- /dev/null +++ b/AdminRedesign/GLM-Associate-Stories.txt @@ -0,0 +1,56 @@ + +INSTRUCTIONS + +This document is indended to "story-board" things a user might do. In effect, we take a customer +objective (I want to...) and give the user a way to get that done. In some cases this might be +a simple "go here and do that". In other cases it might be more complicated. The objective here +is to work though these scenarios and sort out what's best for the user--what gets the user to +the completion of their objective the fastest, easiest, most intuitive way. + +Please add any comments or suggestions for changes rather than just changing things here. These +will be considered and either integrated into the outline, have added comments, or be deleted. + +Use the "General Comments" section for things that are not specific to a particular area below that. + + + +GASLIGHT MEDIA ASSOCIATE USER STORIES +------------------------------------- + +INDEX - Things a user would want to do as questions + +General + * I installed the GLM Associate, now what? + +Working with Members + * I want to add my first member, how do I do that? + + + + +DETAIL + + +---------------------------------------- + +I installed the GLM Associate, now what? + + * Here's what you need to know about our user interface. + + * (how do we explain our user interface + + * There's a few things we need you to look at first + + * These are general management options you might want to change + + * How do you want to refer to your members? + + + +---------------------------------------- + +I want to add my first member, how do I do that? + + * ... + + diff --git a/GLM-Associate-Admin-Flow.txt b/GLM-Associate-Admin-Flow.txt deleted file mode 100644 index 1bdc53e..0000000 --- a/GLM-Associate-Admin-Flow.txt +++ /dev/null @@ -1,154 +0,0 @@ - -INSTRUCTIONS - -This document is intended to develop into a detailed specification for the admin area. It should -evolve from a rough strategic document to that fully detailed specification. It's OK to include -items that generally describe what we want and how that will work and be applied then work out -the details over time. - -Please add any comments or suggestions for changes rather than just changing things here. These -will be considered and either integrated into the outline, have added comments, or be deleted. - -Use the "General Comments" section for things that are not specific to a particular area below that. - -Comments in specific areas should be indented from the item you're commenting on. Precede all of -your comments with your name. Added comments on someone else's comment should be indented further. -For example... - - * Some item already in the outline - Chuck: This is my suggested change - Steve: I tend to agree with this change but we might need to consider ... - Laury: Can we move this to ... - - - -GASLIGHT MEDIA ASSOCIATE ADMIN FLOW SPECIFICATION -------------------------------------------------- - -* General Objectives - - * Provide easy to understand overview and give users a smooth path to greater detail. - * Organize to be consistent with how users might view the overall structure of the admin tasks. - * This may or may not be consistent with organizing by Add-Ons - Something to think about - * Where it makes sense, continue to display summary of all related information when editing/updating - something in that group of related info. I.e. summarized sections that expand to forms when editing but - still leave the other information on the page. - * Standardize user interface so similar things in different areas work the same and are found in consistent locations. - * Provide easy access to related information including management and settings. - * Include General and detailed help information where needed. - * General Help information might be contained in a single document that contains all overall and add-on general - help information - Can use links that target a specific location in that document. This document should be - download able and printable. - * General help information link or icon should be in the same place for all widgets and pages - * Could be separate window for Desktop environment to permit referencing it while doing related work. - * Detailed help information should be available close to where it's needed (i.e. with the field being edited) - * A common Icon or link name should be used for all help information - * General help information should contain a logical organization diagram of related information - It should show how all of the groups of information are related for an application. - * Streamline common tasks - Possibly offer "wizards" for certain things. - * Wizards should use the actual items that the person has to work with normally to do the pieces of the general task - i.e. Required steps to create an Event or setup Registrations. - * As an alternative, or until we build widgets, have general help text show the steps needed to perform common things. - -* User Interface Components - Standardize - - * Menu - * Navigation / Headers to identify where the user is working - * Widgets - Main dashboard - elsewhere??? - * Temporary expanded info and edit possible features - * Expanding region - * Pop-up or overlay - * Sliders - * ??? - -* GLMA Menu - - Provides quick access to GLMA Main Dashboard and direct access to each significant - Add-On page. Some Add-Ons may not require their own page and may not have a menu item. - - * Consider if we should keep sub-menu items? Are they needed and if not how do we avoid them? - Consider if we need this menu at all if we have good navigation from the main GLMA dashboard. - * Current Menu Structure - Please fill in for other Add-Ons - * Members (Dashboard) - * List - Should consider not using these - main list for an add-on should be a feature of add-on dashboard - * Member (current or last accessed member) - might move this to be "last Member' as sub-menu item with "List" - * Files Library - * Settings - * Management - * Import - * Shortcodes - * Contacts - * Coupons - * List - Same here - * Events - * List - Same here - * Leads - * Packages - * Registrations - * List - Same Here - * Requests - * Accounts - Need to finish accounts implementation - -* Main Dashboard - - Main dashboard should provide the following. - - * Access to general Help information - Optionally entire help document. - * Display of relevant status (limited - any?) - * Notification of, and access to, things that need attention - * Access to settings associated with each Add-On widget - * Access to main lists of information in limited format - * Filters and sorting for these lists - * Easy access to expanded info and editing of entries in these lists - * Direct access to the associated add-on Dashboard - * Easy return to a focused widget after linking off to a relevant add-on page or - after use of an edit or info pop-up or slider - - Widgets - - * GLM Associate brief status - Widget - - * Access to related Help information - * Anything general to GLMA that needs attention - * Access to Global settings and management options - * Highlight if required information not completed - i.e. no categories or cities - - * Each add-on - Widget - - * Access to related Help information - * Relevant general status (limited) - * Contains brief summary information of things that need attention or flag that something needs attention - * Easy access to edit/update items needing attention and easy return to this widget - * Current active items of interest - i.e. currently open registrations - * Quick access to detail/edit of active items and easy return to this widget - * Direct access to entries in significant lists - i.e. members - * Quick access to detail/edit of list items and easy return to this widget - -* Individual Add-On pages (including members) - Matches admin menu entry? - - * Access to related Help information - * More detailed status that in Main Dashboard - * Direct access to items needing attention or of current relevance - * Easy access to significant lists - * Expanded information for individual list entries - * Easy access for adding/deleting/updating information - - ---------------------- -Anthony T : 10-9-2019 ---------------------- -* Previous GLMA Admin Revamp Flow - * Basic Flow: ( Single Page Application coordinated mostly with a routed drawer ) - * Dashboard --> widgets --> widget --> open drawer to perform an action (add new entity, edit profile, change settings pertaining to the relevent add-on etc.) - * List View: - * Add New Entity --> opens drawer to present the new entity form - * Selecting List Item --> opens drawer to present the edit / manage entity form(s) - * Settings Button --> opens drawer to present the settings / management options for the relevent section / add-on - * Filters --> filters manipulate the list without page reload - - * Main menu item ( GLM Associate ) leads to the Widget Dashboard - * Entity Name (Members, Events etc. ) leads to the List / Management view for that add-on. (members list, events list etc.) - - * Widget Dashboard : - * wigdets contained basic lists and filters for pending or actionable items related to an add-on - * widgets did not permit management of the add-on internally but routed to the proper section , primarily the drawer which was routed internally \ No newline at end of file -- 2.17.1