User Documentation and Help¶
Feature Overview¶
Provides in-app guides, tutorials, and contextual help for platform users to learn how to use the platform effectively with Auth0 authentication and get assistance when needed.
User Stories¶
US-UM-63: Access Auth0 Authentication Guides and Tutorials¶
As a staffing company user, I want to access comprehensive in-app guides and tutorials about Auth0 authentication, So that I can learn how to use the platform's authentication features effectively.
Acceptance Criteria: - Given I am logged into the platform - When I navigate to the help section - Then I should see a library of guides and tutorials - And the content should be organized by topic and feature - And there should be a dedicated section for Auth0 authentication topics including: - Login methods - Multi-factor authentication setup - Passkey registration and usage - Password management - Account security best practices - And I should be able to search for specific topics - And each guide should include: - Clear step-by-step instructions - Screenshots or illustrations - Expected outcomes - Related topics - When I select a guide - Then I should be able to follow along with the instructions - And the content should be up-to-date with the current version of the platform and Auth0 integration
US-UM-64: Use Contextual Help for Auth0 Authentication¶
As a staffing company user, I want to access contextual help for Auth0 authentication features throughout the platform, So that I can get immediate assistance with authentication without leaving my current task.
Acceptance Criteria: - Given I am logged into the platform - When I am using any Auth0 authentication-related feature - Then I should see help icons or tooltips near complex elements - When I hover over or click on a help icon - Then I should see relevant information about that authentication feature - And the information should be concise and directly applicable to the current context - And for more complex authentication features, I should have the option to access more detailed documentation - And the contextual help should explain: - How the feature works with Auth0 - Security benefits of the feature - Common troubleshooting tips - How local and Auth0 data interact - And the contextual help should not obstruct my workflow - And I should be able to dismiss help overlays easily
US-UM-65: Search Auth0 Authentication Documentation¶
As a staffing company user, I want to search the documentation for specific Auth0 authentication topics, So that I can quickly find answers to my authentication questions.
Acceptance Criteria: - Given I am logged into the platform - When I navigate to the help section - Then I should see a prominent search function - When I enter search terms related to authentication - Then the system should return relevant results from all documentation - And the results should be ranked by relevance - And the search should support: - Keyword matching - Phrase matching - Filtering by authentication topics - Recent searches - Auth0-specific terminology - And each search result should show: - Title of the document - Brief excerpt showing the context - Last updated date - Indication if it's Auth0-specific content - When I select a search result - Then I should be taken directly to the relevant section of the documentation
US-UM-66: View Auth0 Authentication Video Tutorials¶
As a staffing company user, I want to access video tutorials for Auth0 authentication features, So that I can visually learn how to use the authentication features of the platform.
Acceptance Criteria: - Given I am logged into the platform - When I navigate to the help section - Then I should see a section for video tutorials - And the videos should be organized by topic and feature - And there should be a dedicated section for Auth0 authentication tutorials including: - Setting up multi-factor authentication - Using passkeys - Managing passwords - Understanding authentication flows - Troubleshooting common authentication issues - And each video should: - Be short and focused on a specific authentication task - Include captions for accessibility - Have playback controls - Show the current version of the platform and Auth0 integration - Include security best practices - When I select a video - Then it should play within the platform without redirecting me elsewhere - And I should be able to adjust playback speed and volume - And I should be able to view the video in full-screen mode
US-UM-67: Provide Feedback on Auth0 Authentication Documentation¶
As a staffing company user, I want to provide feedback on Auth0 authentication documentation, So that it can be improved for all users.
Acceptance Criteria: - Given I am viewing any Auth0 authentication documentation or help content - Then I should see an option to provide feedback - When I select this option - Then I should be able to: - Rate the helpfulness of the content - Submit specific comments or suggestions - Report errors or outdated information - Indicate if the Auth0-specific information was clear - Suggest additional authentication topics that need documentation - When I submit feedback - Then I should receive confirmation that my feedback was received - And platform administrators should be notified of the feedback - And the feedback should be tracked for documentation improvement - And feedback specifically about Auth0 features should be categorized separately
US-UM-68: Access Auth0 Authentication Getting Started Guide¶
As a new staffing company user, I want to access a getting started guide for Auth0 authentication, So that I can quickly learn how to use the authentication features of the platform.
Acceptance Criteria: - Given I am a new user who has just completed account setup through Auth0 - When I first log into the platform - Then I should be presented with an option to view a getting started guide - And the guide should: - Highlight key authentication features and their security benefits - Explain how Auth0 is used for authentication - Provide a recommended sequence for setting up security features - Include quick links to essential authentication functions - Explain the relationship between local account and Auth0 account - Be dismissible for experienced users - When I complete sections of the guide - Then my progress should be saved - And I should be able to return to the guide at any time - And I should be able to mark the guide as completed when I no longer need it
US-UM-69: Maintain Updated Auth0 Authentication Documentation¶
As a platform administrator, I want to ensure Auth0 authentication documentation is regularly updated, So that users always have access to accurate information about authentication.
Acceptance Criteria: - Given the platform undergoes updates to Auth0 integration or authentication features - When new authentication features are released or existing features are modified - Then the documentation should be updated accordingly - And users should be able to see: - The last updated date for each authentication document - Auth0 version information where applicable - Change logs for major authentication updates - Security recommendations based on current best practices - And the system should flag outdated authentication documentation for review - And administrators should receive reports on authentication documentation usage and feedback - And there should be a process for prioritizing authentication documentation updates based on: - Security importance - User feedback - Frequency of use - Auth0 platform changes
US-UM-70: Provide Auth0 Troubleshooting Guide¶
As a staffing company user, I want to access an Auth0 authentication troubleshooting guide, So that I can resolve common authentication issues without contacting support.
Acceptance Criteria: - Given I am logged into the platform - When I navigate to the help section - Then I should see a dedicated troubleshooting guide for Auth0 authentication - And the guide should cover common issues such as: - Login failures - MFA setup problems - Passkey registration issues - Account linking problems - Session expiration issues - Browser compatibility issues - And each troubleshooting topic should include: - Symptoms of the issue - Potential causes - Step-by-step resolution instructions - Screenshots or illustrations - When to contact support - And the guide should be searchable by error message or symptom - And the guide should be regularly updated based on common support tickets - And users should be able to indicate if a troubleshooting solution resolved their issue
Dependencies¶
- Content management system for documentation
- Search functionality
- Video hosting and playback capabilities
- Feedback collection and tracking system
- Auth0 tenant setup and configuration
- Auth0 documentation and knowledge base access