Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Epic 2.14 Frontend for Writing Feedback Generator #190

Open
5 tasks
Ahmedr275 opened this issue Dec 4, 2024 · 0 comments
Open
5 tasks

Epic 2.14 Frontend for Writing Feedback Generator #190

Ahmedr275 opened this issue Dec 4, 2024 · 0 comments
Labels
frontend This issue is primarly front-end focused type:new-feature For proposals or implementation of entirely new features or functionalities.

Comments

@Ahmedr275
Copy link
Collaborator

Ahmedr275 commented Dec 4, 2024

Frontend Implementation: Writing Feedback Generator Tool


Overview
Upon completion of Issue #119 for developing the Writing Feedback Generator, the FE can be implemented. This issue focuses on the frontend implementation to deliver an intuitive interface for educators to generate detailed and constructive feedback on student writing assignments based on specified criteria.

Details from Backend Issue (#119):
The Writing Feedback Generator tool generates personalized feedback by analyzing uploaded student work against defined rubric criteria or feedback focus. The backend supports inputs such as grade level, assignment description, and writing samples, producing feedback that highlights strengths, areas for improvement, and suggestions for enhancement.


Scope of Work

  1. Tool Description
    The Writing Feedback Generator tool will enable users to input writing samples and rubric criteria, generating detailed feedback that can be displayed, reviewed, and exported.

  2. Design Implementation
    The frontend should align with the provided design mockups to ensure a seamless and user-friendly interface.
    Design Mockup

  3. API Integration

    • Use the backend API to fetch feedback generated for writing samples.
    • Ensure smooth communication between the frontend and backend for submitting inputs and retrieving outputs.
  4. Features to Implement

    • Input Form: Create a form for users to input grade level, assignment description, rubric criteria, and upload student writing samples.
    • Feedback Display: Present feedback in a structured format, including strengths, areas for improvement, and actionable suggestions.
    • Export Functionality: Add options to export feedback as PDF or DOCX documents.
    • Validation: Implement input validation to ensure data is complete and meets required formats.

Acceptance Criteria

  • The frontend matches the design mockup and provides a seamless user experience.
  • The input form captures user data accurately and sends it to the backend API.
  • Generated feedback is displayed in a clear and structured format.
  • Export functionality (PDF and DOCX formats) works correctly.
  • The tool is responsive and functional across devices and browsers.

Resources

  1. Design Mockup
  2. Backend API Documentation
  3. Backend Issue (#119)

Notes
This issue depends on the backend implementation. Frontend developers should refer to the API documentation to test integration and ensure the generated feedback meets user expectations for clarity and quality.

@Ahmedr275 Ahmedr275 added frontend This issue is primarly front-end focused type:new-feature For proposals or implementation of entirely new features or functionalities. labels Dec 4, 2024
@Ahmedr275 Ahmedr275 moved this to Todo in Issues board Dec 4, 2024
@Ahmedr275 Ahmedr275 changed the title Epic 2.10 Frontend for Writing Feedback Generator Epic 2.14 Frontend for Writing Feedback Generator Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
frontend This issue is primarly front-end focused type:new-feature For proposals or implementation of entirely new features or functionalities.
Projects
Status: Todo
Development

No branches or pull requests

1 participant