Dev ops Board

 

Epic: Enhance SharePoint Landing Page (General Users)

Feature 1: Intelligent Question Answering

User Story 1: User asks a question

• As a general user,
• I want to be able to ask a question related to the organization,
• so that I can get a quick and accurate answer.

Acceptance Criteria:

• User can input a question in a text box.
• System displays a loading indicator while processing the query.
• System displays the answer generated by Azure OpenAI based on Azure Search results.
• System displays a notification if no answer is found.

Tasks:

• Create a text input field for the user to enter their question.
• Implement a loading indicator to display while processing the query.
• Integrate Azure Search to retrieve relevant documents based on the question.
• Integrate Azure OpenAI to generate an answer based on the retrieved documents.
• Display the generated answer to the user.
• Implement a notification system to display when no answer is found.
• Handle potential errors during search, AI processing, or answer generation.

User Story 2: User views similar questions

• As a general user,
• I want to see similar questions while typing my query,
• so that I can refine my question or find existing answers.

Acceptance Criteria:

• System displays similar questions as user types in the question box.
• Similar questions are fetched based on keywords from the user's input.

• Tasks:
  • Implement a mechanism to capture user input as they type.
  • Integrate Azure Search to retrieve similar questions based on typed keywords.
  • Display similar questions in a suggested list below the input field.
  • Handle cases where no similar questions are found.
  • Ensure performance efficiency for real-time suggestions.
    
    

Feature 2: Question Management

User Story 3: User views their asked questions

• As a general user,
• I want to see a history of my asked questions,
• so that I can track my queries and their answers.

Acceptance Criteria:

• System displays a list of the user's recent questions.
• Each question displays its corresponding answer.
• List is paginated for better user experience.

Tasks:

• Store user questions and their corresponding answers in a database or storage.
• Retrieve the user's question history based on user authentication.
• Display a paginated list of questions and answers.
• Implement a clear and visually appealing layout for the question history.
• Handle cases where the user has no previous questions.

Feature 3: Admin Panel (Part of Header component)

User Story 4: Admin manages question categories

• As an admin,
• I want to manage question categories,
• so that users can easily categorize their questions.

Acceptance Criteria:

• Admin can add, edit, and delete question categories.
• System provides a list of existing categories for easy management.

Tasks:

• Create an admin interface for managing question categories.
• Implement functionality to add new question categories.
• Implement functionality to edit existing question categories.
• Implement functionality to delete question categories.
• Display a list of all question categories for easy management.
• Handle potential errors during category management.

User Story 5: Admin maps SMEs to categories

• As an admin,
• I want to map subject matter experts (SMEs) to specific question categories,
• so that unanswered questions can be assigned to the correct SME.

Acceptance Criteria:

• Admin can assign one or more SMEs to a category.
• System provides a list of available SMEs for mapping.

Tasks:

• Create a user management module to manage SME information.
• Implement a mapping mechanism between SMEs and question categories.
• Provide a user interface to display and manage SME mappings.
• Handle cases where no SMEs are available for a category.
• Ensure data integrity and consistency during SME mapping.

Component: All Questions

User Story: As a general user, I want to see a list of popular questions, so that I can quickly find information.

Acceptance Criteria:

• Displays a list of the top 5-10 most popular or recent questions.
• Each question includes a title and a brief summary.
• Clicking on a question takes the user to the detailed answer page.

Tasks:

• Design the layout of the "All Questions" component.
• Implement a component to fetch the top 5-10 questions from the data source.
  • Define the data structure for fetched questions.
  • Implement API calls or database queries to retrieve questions.
  • Handle potential errors or empty responses.
• Create a reusable question card component.
  • Define the structure of the question card (title, summary, etc.).
  • Implement the card's visual appearance and layout.
• Handle click events on question cards.
  • Implement navigation logic to the answer page.
  • Pass necessary question details to the answer page.

Component: Quick Links

User Story: As a general user, I want to access relevant resources quickly, so that I can find information efficiently.

Acceptance Criteria:

• Displays a list of predefined links.
• Each link has a clear and descriptive label.
• Links open in a new tab or window.

Tasks:

• Define the list of quick links and their corresponding URLs.
• Design the layout of the "Quick Links" component.
• Create a reusable link component.
  • Define the structure of the link (label, URL).
  • Implement the link's visual appearance and behavior.
• Handle click events on links.
  • Open links in a new tab or window.

Component: Top Category

User Story: As a general user, I want to see the most popular question categories, so that I can easily navigate to relevant questions.

Acceptance Criteria:

• Displays a list of the top categories based on question count.
• Categories are displayed in descending order based on question count.
• Clicking on a category filters the question list to show only questions from that category.

Tasks:

• Fetch the top categories and their corresponding question counts.
  • Define the data structure for categories and counts.
  • Implement API calls or database queries to retrieve category data.
  • Handle potential errors or empty responses.
• Design the layout of the "Top Category" component.
• Create a reusable category item component.
  • Define the structure of the category item (category name, count).
  • Implement the category item's visual appearance.
• Handle click events on categories.
  • Implement filtering logic for the question list.
  • Update the question list based on the selected category.

Component: Footer

User Story: As a user, I want to have access to general information and contact details, so that I can find help or additional information.

Acceptance Criteria:

• Displays the organization's name, logo, and contact information.
• Includes links to privacy policy, terms of use, and other legal information.
• Provides copyright information.

Tasks:

• Design the layout of the footer.
• Add company logo, name, and contact information.
• Create links to privacy policy, terms of use, and other legal information.
• Add copyright information.
• Consider responsive design for different screen sizes.

Additional Considerations

• Error Handling: Implement proper error handling for API calls, search queries, and other potential issues.
• Performance: Optimize the system for fast response times, especially when handling multiple simultaneous queries.
• Security: Ensure data privacy and security by following appropriate security measures.
• Accessibility: Design the web part to be accessible to users with disabilities.
• Testing: Conduct thorough unit, integration, and user acceptance testing.

By breaking down the epic into features and user stories, you can prioritize development efforts and ensure that the final product meets the needs of both general users and administrators.

Component: My Questions

• User Story: As a logged-in user, I want to see a list of my recent questions, so I can easily track my previous queries.
  • Acceptance Criteria:
    • Display a list of the user's most recent 5-10 questions.
    • Each question should include a title and a brief summary.
    • Clicking on a question should navigate to the detailed question page.
  • Functional Requirements:
    • Retrieve the user's question history from SharePoint using REST API or Graph API.
    • Display the most recent 5-10 questions in a list format.
    • Implement pagination if there are more than 10 questions.
    • Create a React component to display the list of questions.
    • Handle cases where the user has no previous questions.

Component: All Questions

• User Story: As a user, I want to see a list of the most popular questions, so I can easily discover frequently asked questions.
• Acceptance Criteria:
  • Display a list of the top 5-10 most popular questions.
  • Each question should include a title and a brief summary.
  • Clicking on a question should navigate to the detailed question page.
• Functional Requirements:
• Retrieve the top 5-10 most popular questions from SharePoint using REST API or Graph API.
• Determine the popularity metric (e.g., number of views, likes, comments).
• Display the questions in descending order based on popularity.
• Create a React component to display the list of questions.
• Handle cases where there are fewer than 5 questions.

User Stories, Acceptance Criteria, and Functional Requirements

Component: Header

• User Story: As a logged-in user, I want to see my user information and notifications, so I can easily access my profile and relevant alerts.
  • Acceptance Criteria:
    • Display the logged-in user's name or initials.
    • Display a notification count or icon.
    • Display a home page icon.
  • Functional Requirements:
    • Use SharePoint's People Picker to retrieve the user's information.
    • Use SharePoint's REST API or Graph API to retrieve notification data.
    • Implement a notification count or unread notification indicator.
    • Create a React component for the header with appropriate styling.

Component: Footer

• User Story: As a user, I want to see copyright information and the current time, so I can acknowledge the website's ownership and know the current time.
  • Acceptance Criteria:
    • Display the copyright information.
    • Display the current time in a user-friendly format.
  • Functional Requirements:
    • Use JavaScript's Date object to display the current time.
    • Implement a world clock functionality if required.
    • Create a React component for the footer with appropriate styling.

Component: Home Page (All Questions)

• User Story: As a user, I want to see a list of all questions, so I can easily browse through them.
  • Acceptance Criteria:
    • Display a list of all questions.
    • Each question should have a title and a brief description.
    • The question list should be paginated.
  • Functional Requirements:
    • Retrieve question data from SharePoint using REST API or Graph API.
    • Create a React component to display the question list.
    • Implement pagination using React libraries or custom logic.
    • Handle loading states and error scenarios.

Component: Request Access

• User Story: As a non-authenticated user, I want to request access to the platform, so I can gain access to the content.
  • Acceptance Criteria:
    • Display a prominent "Request Access" button.
    • Upon clicking the button, display a form to collect user information.
    • Submit the collected information to a designated endpoint.
  • Functional Requirements:
    • Create a React component for the "Request Access" button.
    • Design and implement a form to capture user details.
    • Handle form submission and data validation.
    • Integrate with a backend service to process access requests.

Component: Homepage (Combined)

• User Story: As a user, I want to see a comprehensive homepage with all relevant information, so I can easily navigate and find what I need.
  • Acceptance Criteria:
    • Display the "All Questions" component.
    • Display the "Quick Links" component.
    • Display the "Contact Details" component.
    • Display the "Top Category" component.
  • Functional Requirements:
    • Combine the previously created components into a single homepage layout.
    • Ensure proper responsiveness and adaptability to different screen sizes.
    • Consider using CSS Grid or Flexbox for layout.