From: Chuck Scott Date: Fri, 18 Oct 2019 17:09:13 +0000 (-0400) Subject: Reorganized AdminRedesign X-Git-Url: http://cvs2.gaslightmedia.com/gitweb/?a=commitdiff_plain;h=dd1aa1d1580090352a01a79803cb0400c0962036;p=prog%2Fglm-documentation.git Reorganized AdminRedesign --- diff --git a/AdminRedesign/Admin-Flow.txt b/AdminRedesign/Admin-Flow.txt new file mode 100644 index 0000000..8405988 --- /dev/null +++ b/AdminRedesign/Admin-Flow.txt @@ -0,0 +1,83 @@ +Gaslight Media Associate Admin Flow +=================================== + +This document should develop into a detailed flow of the reworked admin area. It should +be in an outline format with short descriptions. If in any case there is are sections that are referenced from +multiple locations, that section should exist once and be referenced from any such locations. + + + +*** 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/AdminRedesign/Admin-Objectives.txt b/AdminRedesign/Admin-Objectives.txt new file mode 100644 index 0000000..954b556 --- /dev/null +++ b/AdminRedesign/Admin-Objectives.txt @@ -0,0 +1,91 @@ + +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 ... + + +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. + diff --git a/AdminRedesign/Admin-Requests.txt b/AdminRedesign/Admin-Requests.txt new file mode 100644 index 0000000..8530411 --- /dev/null +++ b/AdminRedesign/Admin-Requests.txt @@ -0,0 +1,42 @@ +GLMA Admin Issues and Requests +------------------------------ + +* Implement standard UI elements and Foundation 6 across all of admin section + + * Image tags need alt or decorative attributes. ‘alt=”” is decorative’ + * Need to work on making output for each plugin ADA compliant. + +* Plugin Specific +. + * Members Plugin + * Move Settings into the plugin + * Streamline the member and member profile edit pages so their one page + * Client need a way to send out notifications to their members, much like we have in the Event Registrations plugin. (with send now) Messages Plugin + * Add County to the member search filter in admin. (request by Jodie 10/10/19) + * Events Plugin task#40611 + * Move Settings into the plugin + * Ability to add event category to the event url task#35231 + * Image Tags need alt or decorative attributes + * Contact Plugin + * Merge the migcsa work for contacts into main develop branch and release Chuck Says NO. + * Move settings into the plugin + * Audit Log for contacts (member contacts) High Priority + * Billing Plugin + * Move settings into the plugin (completed on develop) + * Test develop branch + - Square Payments + - Test with Migcsa billing + * Update multi selects with the jquery plugin used on member category search + * Custom Fields Plugin + 1. Add Management Options for custom fields plugin task#36480 + * Messaging Plugin + 1. Ready for review task#36957 + 2. Stats filter (complete) + +* General + + * Create task for each website to update their gravity forms plugin and setup reCaptcha for the forms. + * Update any add on plugins for gravity forms first. + + + diff --git a/AdminRedesign/Existing-Admin-Flow.txt b/AdminRedesign/Existing-Admin-Flow.txt new file mode 100644 index 0000000..1059107 --- /dev/null +++ b/AdminRedesign/Existing-Admin-Flow.txt @@ -0,0 +1,9 @@ +Gaslight Media Associate Existing Admin Flow +============================================ + +This document should list the entire flow of the exsiting admin interface. That should +include all menus, sub-menues, tabs, links, etc and at list all logical portions of the +existing admin areas including Management and Settings. It should be in outline format +with short descriptions. If in any case there is are sections that are referenced from +multiple locations, that section should exist once and be referenced from any such locations. + diff --git a/AdminRedesign/GLM-Associate-Admin-Flow.txt b/AdminRedesign/GLM-Associate-Admin-Flow.txt deleted file mode 100644 index eb7aa33..0000000 --- a/AdminRedesign/GLM-Associate-Admin-Flow.txt +++ /dev/null @@ -1,177 +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 ... - - -== 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/AdminRedesign/GLM-Associate-Admin-Requests.txt b/AdminRedesign/GLM-Associate-Admin-Requests.txt deleted file mode 100644 index 8530411..0000000 --- a/AdminRedesign/GLM-Associate-Admin-Requests.txt +++ /dev/null @@ -1,42 +0,0 @@ -GLMA Admin Issues and Requests ------------------------------- - -* Implement standard UI elements and Foundation 6 across all of admin section - - * Image tags need alt or decorative attributes. ‘alt=”” is decorative’ - * Need to work on making output for each plugin ADA compliant. - -* Plugin Specific -. - * Members Plugin - * Move Settings into the plugin - * Streamline the member and member profile edit pages so their one page - * Client need a way to send out notifications to their members, much like we have in the Event Registrations plugin. (with send now) Messages Plugin - * Add County to the member search filter in admin. (request by Jodie 10/10/19) - * Events Plugin task#40611 - * Move Settings into the plugin - * Ability to add event category to the event url task#35231 - * Image Tags need alt or decorative attributes - * Contact Plugin - * Merge the migcsa work for contacts into main develop branch and release Chuck Says NO. - * Move settings into the plugin - * Audit Log for contacts (member contacts) High Priority - * Billing Plugin - * Move settings into the plugin (completed on develop) - * Test develop branch - - Square Payments - - Test with Migcsa billing - * Update multi selects with the jquery plugin used on member category search - * Custom Fields Plugin - 1. Add Management Options for custom fields plugin task#36480 - * Messaging Plugin - 1. Ready for review task#36957 - 2. Stats filter (complete) - -* General - - * Create task for each website to update their gravity forms plugin and setup reCaptcha for the forms. - * Update any add on plugins for gravity forms first. - - - diff --git a/AdminRedesign/GLM-Associate-Stories.txt b/AdminRedesign/GLM-Associate-Stories.txt deleted file mode 100644 index 13b70b1..0000000 --- a/AdminRedesign/GLM-Associate-Stories.txt +++ /dev/null @@ -1,58 +0,0 @@ - -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? - - (more needed) - - - ----------------------------------------- - -I want to add my first member, how do I do that? - - * ... - - diff --git a/AdminRedesign/UI-Design-Main-Dashboard.odg b/AdminRedesign/UI-Design-Main-Dashboard.odg deleted file mode 100644 index e409bd9..0000000 Binary files a/AdminRedesign/UI-Design-Main-Dashboard.odg and /dev/null differ diff --git a/AdminRedesign/UI-Design-Main-Dashboard.pdf b/AdminRedesign/UI-Design-Main-Dashboard.pdf deleted file mode 100644 index 7577dcd..0000000 Binary files a/AdminRedesign/UI-Design-Main-Dashboard.pdf and /dev/null differ diff --git a/AdminRedesign/UI-Elements.txt b/AdminRedesign/UI-Elements.txt new file mode 100644 index 0000000..c72b7a2 --- /dev/null +++ b/AdminRedesign/UI-Elements.txt @@ -0,0 +1,8 @@ +Gaslight Media Associate Standard UI Elements +============================================= + +This document should be a list of all UI Elements that are to be used in the +updated admin interface. Each should have a short descirption and all options +associated with it. + + diff --git a/AdminRedesign/User-Stories.txt b/AdminRedesign/User-Stories.txt new file mode 100644 index 0000000..13b70b1 --- /dev/null +++ b/AdminRedesign/User-Stories.txt @@ -0,0 +1,58 @@ + +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? + + (more needed) + + + +---------------------------------------- + +I want to add my first member, how do I do that? + + * ... + + diff --git a/AdminRedesign/Visual-Design-Drawings/UI-Design-Main-Dashboard.odg b/AdminRedesign/Visual-Design-Drawings/UI-Design-Main-Dashboard.odg new file mode 100644 index 0000000..e409bd9 Binary files /dev/null and b/AdminRedesign/Visual-Design-Drawings/UI-Design-Main-Dashboard.odg differ diff --git a/AdminRedesign/Visual-Design-Drawings/UI-Design-Main-Dashboard.pdf b/AdminRedesign/Visual-Design-Drawings/UI-Design-Main-Dashboard.pdf new file mode 100644 index 0000000..7577dcd Binary files /dev/null and b/AdminRedesign/Visual-Design-Drawings/UI-Design-Main-Dashboard.pdf differ diff --git a/AdminRedesign/readme.txt b/AdminRedesign/readme.txt new file mode 100644 index 0000000..35b6aa3 --- /dev/null +++ b/AdminRedesign/readme.txt @@ -0,0 +1,33 @@ +Gaslight Media Associate Admin Redesign Documentation Overview +============================================================== + +File Directory: + + Admin-Flow.txt Detailed admin flow outline + Admin-Objectives.txt Comprehensive list of Objectives + Admin-Requests.txt Specific customer or GLM requests, problems stated + Existing-Admin-Flow.txt Detailed admin flow for existing admin interface + User-Stories.txt User "stories" in the form of questions and answers + UI-Elements.txt Proposed UI elements + readme.txt This file + + Visual-Design-Drawings LibreDraw files and PDF exports of interface mockups + UI-Design-Main-Dashboard.odg/pdf Main Dashboard with Overlay + + + +== Changelog == += Pending = +* Created drawing files directory and moved drawings into that +* Simplified filenames to remove obvious duplicate information +* Added User Interface elements file +* Broke main flow file into two - Admin-Flow.txt and Admin-Objectives.txt + += 10/15/19 - Chuck = +* Restructured objectives +* Reduced some initial flow specifics. +* Created "GLM-Associate-Stories.txt" file <<<<< See This file!!! + + + +