Help Feature List

[edarsow]

User Requirements for System Help:

• Display of help information should occur in a separate window from main system, allowing for simultaneous viewing of both the active page and its help
• Links to help contents exist at the individual page tool level, even down to a specific database field or form control (as opposed to a single, long help page for all features on in a given system area)
• After clicking a help icon and the help window is displayed, the clicking of a second help icon redirects the original help window (and doesn't spawn a third window)
• Two levels of help: Overall page guidance that provides overviews of what features are available on a given page and a operation-specific help level that relates to a specific page tool

System pages/sections: Emily TODO

Example: Page-level help sections

• Do we want a Help article search in the upper navigation?
• Dashboard
  • Overall page guidance (maybe organized in terms of most common actions that will need to be taken, ie "How to File a Complaint")
  • Activity in COG Land (queries) docs/dashboard/recentactivity.md
  • Case List Builder (queries) docs/dashboard/caselistbuilder.md
  • Property Search (esp. custom/advanced search)
• Code Enforcement Case Profile
  • Overall page guidance (what to do first, what is meant by "Events" and "Actions", outlines features available on page, etc)
  • Code Violations -> Choose Ordinance (how to quickly locate the ordinance you are looking for instead of scrolling through the whole screen)
    • Make these findings enforceable checkbox
  • Add Event -> Attaching new event to case ID (esp. Custom/Legacy Import)
  • Notices of Violation
  • Action Requests (what causes something to get populated there?)
  • Fee Record Configuration Tool
    • Edit fee permissions
    • Manage fee types
    • Modes (Lookup, Insert, Update, Waive)
    • LookUp Panel
    • Insert Panel
    • Manage Payments
    • Manage payment types
    • Modes (Lookup, Insert, Update, Remove)
    • LoopUp Panel (typo)
    • Insert Panel
    • Public Access Settings
    • Allow access using ref num? (explain what this means)
    • Allow action request linking? (explain what this means)
• Properties
  • Overall page guidance
  • Property Search
    • Type of Search
    • Search Criteria and Advanced Search
    • Filter by street number
    • Clear
  • Units
    • Currently unsure what sub articles will be needed without seeing what the functionality will look like (whether or not how to use it will be obvious/straightforward)
  • Persons- Link Person to Property
• Person Search
  • Overall page guidance
  • Search for persons
  • Load person history (under "Person search results"- it was unclear to me what this does)
  • Person changes
• Occupancy
  • Period search and workflow
    • Overall page guidance
    • Run preset query
  • Occupancy Permits
  • Manage Occupancy Permits Applications
    • Search, Actions, Connections, Notes bar (explain what each one means/does)
    • Search Panel
  • Inspection Checklist
    • Inspection Configuration
  • Fee Record Configuration Tool (is this different than the one under CE Cases?)
    • Edit fee permissions
    • Manage fee types
    • Modes (Lookup, Insert, Update, Waive)
    • LookUp Panel
    • Insert Panel
  • Manage Payments (is this different than the one under CE Cases?)
    • Manage payment types
    • Modes (Lookup, Insert, Update, Remove)
    • LoopUp Panel (typo)
    • Insert Panel
• Occupancy Checklist
  • Unsure what specifically we will need at this point
• Occupancy Permit Type
  • Unsure what specifically we will need at this point
  • Court Entity Configuration Tool
  • Overall page guidance
• Code docs/code/code.md
  • Ordinances docs/code/ordinances.md
  • Manage Code Books docs/code/codebooks.md
• Events (under Reports in side nav)
  • Overall page guidance
  • Create a new event
  • Event list/prepare event report
• System (side nav)
  • Unsure what will be needed

Notes

• Instead of "Finish editing fee list and return", I would suggest "Back to previous page" or something along those lines. It took me a few times of clicking on the screen to realize that that is how I could go back. (on Add Fees and Add Payments sections of Code Enforcement Case Profile)
• Will the functionality for adding a CE case under Properties eventually look like it does on the CE Case Profile screen? (ability to click on the ordinance the case falls under, etc)

Bugs

• Was unable to Add Event (would not let me scroll down far enough to be able to save it)
• Was unable to Add New Citation (would not let me scroll down far enough to save it)
• Was unable to Create new person (would not let me scroll down far enough to save it)
• I tried connecting Emily Moldovan to 110 Fenwick Drive and it didn't look like anything happened

[edarsow]

This is now incarnated in the ticket spreadsheet and documentation system!!! Thanks Emily!!!