Adding more detailed content to Existing-Admin-Flow.txt file.
authorChuck Scott <cscott@gaslightmedia.com>
Mon, 21 Oct 2019 19:25:32 +0000 (15:25 -0400)
committerChuck Scott <cscott@gaslightmedia.com>
Mon, 21 Oct 2019 19:26:16 +0000 (15:26 -0400)
AdminRedesign/Admin-Specifications.txt [new file with mode: 0644]
AdminRedesign/Existing-Admin-Flow.txt
AdminRedesign/readme.txt

diff --git a/AdminRedesign/Admin-Specifications.txt b/AdminRedesign/Admin-Specifications.txt
new file mode 100644 (file)
index 0000000..8956bdc
--- /dev/null
@@ -0,0 +1,17 @@
+Gaslight Media Associate Admin Specifications
+=============================================
+
+This document should develop into a detailed specification of all admin functionality. It should
+be sufficiently detailed to use as a reference for testing functionality and for determining if
+requested changes and updates should or can be applied.
+
+Not sure how this should be organized at this point. Perhaps if it's going to be used for testing
+and verification of admin functionality it should be possible to work down through this specification
+and test that each specification is properly accommodated in the product using the planned admin flow.
+
+Consider if this specification should be encorporated in the Admin-Flow.txt file.
+
+
+
+
+
index 9f1af31..c37baeb 100644 (file)
@@ -7,124 +7,274 @@ existing admin areas including Management and Settings. It should be in outline
 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.
 
+Please note the "*** {something} ***" type notes. These represent issues with the current
+user interface.
 
-- GLM Associate: Main dashboard for all plugins.
-    - Members:  same as GLM Associate
-    - Member: unknown
-        Gives message 'No member currently selected' in red! Why?
-    - Settings: Dashboard for GLM Associate Settings
-        - Member Profiles
-            - Dashboard
-                Display summary of Profile Settings (Member edits moderated)
-                Email Notifications To setting with link.
-                Signup Form Setting with link.
-            - Member Types
-                Add/Edit/Delete Member Types.
-            - Categories
-                Add/Edit/Delete Categories.
-            - Amenities
-                Add/Edit/Delete Amenities.
-            - Cities
-                Add/Edit/Delete Cities.
-            - Regions
-                Add/Edit/Delete Regions.
-            - Counties
-                Add/Edit/Delete Counties.
-            - Email Notifications
-                Configure Settings for member pending notifications.
-            - Signup Form
-                Configure Settings for Signup Form.
-        - Event Categories
-            Edit/Add/Delete Event Categories
-        - Event Email Settings
-            Configure To, From/Reply To, Email Notification Message, Declined
-            Message and Approved Message
-        - Registrations
-            Configure Global Terms & Conditions, List & Registration Pages,
-            Cart Page, Checkout Page, Summary Page,
-            Email Notifications: Notification to Site Owner, Event Contacts,
-            Person Submitting the Registrations, attendees, Acknowledgement to
-            Person Submitting Registration when a manually process payment is
-            accepted. Acknowledgement to Attendees when a manually processed
-            payment is accepted. List of Merge Tags.
-    - Management
-        - General Settings
-            - Misc. Settings
-            - Member List Options
-            - Member Detail Options
-            - Required Pages
-            - Members Only
-        - Terms and Phrases
-        - Development
-        - Members
-        - Add-Ons
-        - Hooks
-        - Crons
-        - Videos
-        - Contacts
-            - Contact Options
-            - Clear Archived
-        - Events
-            - Settings
-            - iCal Feeds
-            - Import
-            - Timely Import
-            - Events Manager Import
-        - Packages
-            - Packaging General
-            - Package List
-            - Package Detail
-            - Import Packages
-        - Registrations
-            - General Settings
-            - Terms and Phrases
-    - Import
-        - Import CSV
-        - Import Photos
-        - Import Files
-        - Import Videos
-        - Member Contacts
-        - Verify Member Data
-    - Shortcodes
-        - GLM Associate
-        - billing
-        - Contacts
-        - Events
-        - Packaging
-        - Registrations
-    - Billing
+Organized starting with menu items
+
+Item Charcter   Decription
+----------------------------------
+    -           Menu Item
+    --          Sub Menu Item
+    =           Page Tab
+    L           Link
+    B           Button
+    U           Selection UI Element
+    !           Notification
+    S           Separate section of page
+    T           Table
+    I           Information
+    .           Misc Item
+
+
+-   "GLM Associate" primary menu & "Members" menu item
+        Main dashboard for all plugins.
+        Duplicate functionality as "Members" menu item - *** Confusing ***
+
+    =   "Dashboard" tab
+            Supposed to provide an overview of important GLM Assicate status sand quick access
+            to important things.
+
+        U   "Member Search" field (If members enablesd)
+                Self-completing list of members displayed when typing first letters of a member.
+                Selecting a member takes user to "Member Dashboard" tab of "Member" menu.
+                See "Member" menu.
+
+        B   "Add a New Member" button (if members enabled)
+                Takes user to "Member Dashboard" of "Member" menu item showing an "Add New Member" form
+                See "Member Menu"
+                There is no way to add a new member from the "Member" menu, *** Confusing ***
+
+        !   Notifications
+                Things that need attention
+
+            .   No Member Types
+                    Shows if "Member Types" list in "Settings" is empty
+
+                L   "Click here to add Member Types"
+                        Takes user to "Settings", "Member Profiles", "Member Types" tab
+
+            .   No Categories
+                    Shows if "Categories" list in "Settings" is empty
+
+                L   "Click here to add Categories"
+                        Takes user to "Settings", "Member Profiles", "Categories" tab
+
+            .   No Amenities
+                    Shows if "Amenities" list in "Settings" is empty
+
+                L   "Click here to add Amenities"
+                        Takes user to "Settings", "Member Profiles", "Amenities" tab
+
+            .   No Cities
+                    Shows if "Cities" list in "Settings" is empty
+
+                L   "Click here to add Cities"
+                        Takes user to "Settings", "Member Profiles", "Cities" tab
+
+            .   No counties (if counties enabled)
+                    Shows if "Counties" list in "Settings" is empty
+
+                L   "Click here to add Counties"
+                        Takes user to "Settings", "Member Profiles", "Counties" tab
+
+            .   No Regions
+                    Shows if "Regions" list in "Settings" is empty
+
+                L   "Click here to add Regtions"
+                        Takes user to "Settings", "Member Profiles", "Regions" tab
+
+            .   No members (if members enabled)
+                    Shows if there are no members listed (if members a enabled)
+
+                L   "Click here to create your first member"
+                        Takes user to "Member Dashboard" of "Member" menu item showing an "Add New Member" form
+                        See "Member Menu"
+
+        I   "Number of Members Listed" (if members enabled)
+                Number of members currently listed
+
+        S   "Pending Member Profiles" (if members enabled)
+                Note that this is different from other possible sections in the main dashboard.
+                The other possible sections that can show up here have the name of the section that is a
+                link to them menu for that area of the GLM Associate possibly followed by some other text.
+                This section has no link. Should be to "Members. *** Confusing ***
+
+            T   List of members with pending profiles
+                    If none, this section doesn't display
+                    List columns: "Member Name", "Profile Name", {last updated}
+
+                L   {member name}
+                    Link to member information when user is expecting a pending profile, *** Confusing ***
+                    See "Member" sub-menu, "Member Dashboard"
+
+                L   {profile name}
+                    Link to Basic information for selected member profile
+                    See "Member", "Membee Dashboard", "Profile Data"
+
+                I   Date and time profile on this line
+
+        S   "Events (Pending)" (if Event Add-On is running and any events are pending)
+                Note that the order of fields in the list in this section is not logically
+                the same as it is for "Pending Member Profiles" and others.
+                Need to make column organization standardized.  *** Confusing ***
+
+        S   "Coupons (Pending)" (If Coupons Add-On is running)
+                *** More Info Here***
+
+        S   "Leads" (If Leads Add-On is running)
+                *** More Info Here***
+
+        S   "Packages (Current)" (If Packages Add-On is running)
+                *** More Info Here***
+
+    = "Members List" tab
+        Duplicates "List" sub-menu item - *** Confusing ***
+
+-- "List" - Sub-Menu
+        Duplicates functionality of "Members List" tab - *** Confusing ***
+
+
+- Members: same as GLM Associate
+
+- Member:  Used to manage information on a specific member.
+    ? Gives message 'No member currently selected' in red! Why?
+        This is because this menu is for managing the currently selected member.
+        The currently selected member is the last member selected from the members "List".
+        Something became broken with this at some point.
+
+            (Oops, this goes here somewhere)
+                B   "Activate"
+                        Activates this member profile
+                        Deactivates any other active profile for this member
+                        Takes user to "Member" menu, "Member Dashboard" for this member
+
+                B   "Clone"
+                        Creates a complete clone of this member profile
+
+
+
+- Settings: Dashboard for GLM Associate Settings
+    - Member Profiles
         - Dashboard
-        - Accounts
-            - Add New Account
-            - Accounts Export
-        - Invoices
-            - Create Invoice
-        - Payments
-            - Payments Export
-            - Create Payment
-        - Invoicing
-            - Create Invoices
-            - Print Invoices
-            - Create Labels
-            - Send Emails
+            Display summary of Profile Settings (Member edits moderated)
+            Email Notifications To setting with link.
+            Signup Form Setting with link.
+        - Member Types
+            Add/Edit/Delete Member Types.
+        - Categories
+            Add/Edit/Delete Categories.
+        - Amenities
+            Add/Edit/Delete Amenities.
+        - Cities
+            Add/Edit/Delete Cities.
+        - Regions
+            Add/Edit/Delete Regions.
+        - Counties
+            Add/Edit/Delete Counties.
+        - Email Notifications
+            Configure Settings for member pending notifications.
+        - Signup Form
+            Configure Settings for Signup Form.
+    - Event Categories
+        Edit/Add/Delete Event Categories
+    - Event Email Settings
+        Configure To, From/Reply To, Email Notification Message, Declined
+        Message and Approved Message
+    - Registrations
+        Configure Global Terms & Conditions, List & Registration Pages,
+        Cart Page, Checkout Page, Summary Page,
+        Email Notifications: Notification to Site Owner, Event Contacts,
+        Person Submitting the Registrations, attendees, Acknowledgement to
+        Person Submitting Registration when a manually process payment is
+        accepted. Acknowledgement to Attendees when a manually processed
+        payment is accepted. List of Merge Tags.
+
+- Management
+    - General Settings
+        - Misc. Settings
+        - Member List Options
+        - Member Detail Options
+        - Required Pages
+        - Members Only
+    - Terms and Phrases
+    - Development
+    - Members
+    - Add-Ons
+    - Hooks
+    - Crons
+    - Videos
     - Contacts
-        - Add New Member Contact
-        - Contact Export/Reports
+        - Contact Options
+        - Clear Archived
     - Events
-        - Dashboard
-        - Event List
-        - Add A New Event
+        - Settings
+        - iCal Feeds
+        - Import
+        - Timely Import
+        - Events Manager Import
     - Packages
+        - Packaging General
+        - Package List
+        - Package Detail
+        - Import Packages
+    - Registrations
+        - General Settings
+        - Terms and Phrases
+
+- Import
+    - Import CSV
+    - Import Photos
+    - Import Files
+    - Import Videos
+    - Member Contacts
+    - Verify Member Data
+
+- Shortcodes
+    - GLM Associate
+    - billing
+    - Contacts
+    - Events
+    - Packaging
     - Registrations
-        - List
-            - Dashboard
-                - Add a Registration Event
-                - Display Notifications E-Mails sent today
-            - Dashboard For Last Selected Event
-            - Global Payment Codes
-        - Requests
-            - Request Dashboard
-            - Last Selected Request
-        - Accounts
-            - Dashboard
-            - Last Selected Account
+
+- Billing
+    - Dashboard
+    - Accounts
+        - Add New Account
+        - Accounts Export
+    - Invoices
+        - Create Invoice
+    - Payments
+        - Payments Export
+        - Create Payment
+    - Invoicing
+        - Create Invoices
+        - Print Invoices
+        - Create Labels
+        - Send Emails
+
+- Contacts
+    - Add New Member Contact
+    - Contact Export/Reports
+
+- Events
+    - Dashboard
+    - Event List
+    - Add A New Event
+
+- Packages
+
+- Registrations
+    - List
+        - Dashboard
+            - Add a Registration Event
+            - Display Notifications E-Mails sent today
+        - Dashboard For Last Selected Event
+        - Global Payment Codes
+    - Requests
+        - Request Dashboard
+        - Last Selected Request
+    - Accounts
+        - Dashboard
+        - Last Selected Account
index 35b6aa3..09449ea 100644 (file)
@@ -1,27 +1,30 @@
 Gaslight Media Associate Admin Redesign Documentation Overview
 ==============================================================
 
-File Directory:
+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
+    Admin-Specifications.txt  Detailed specification of admin functionality
     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
+    readme.txt                This file
+    UI-Elements.txt           Proposed UI elements
+    User-Stories.txt          User "stories" in the form of questions and answers
 
     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
+* Added "Admin-Specifidcations.txt" file
+* Updated "Existing-Admin-Flow.txt" file
 
 = 10/15/19 - Chuck =
 * Restructured objectives