Requirements - sharath1996/resume-builder GitHub Wiki

This page is meant to capture the requirements

Stake Holder level requirement(s)

Profile Handling

  • The user shall be able to create, view, modify and delete the profile.
  • The user shall have a dedicated window for his profile updates.
  • The user shall be able to review his profile using Generative AI services.

Resume Generation

  • The user shall be able to generate the resume based on given job description.
  • The user shall be able to modify the generated resume before exporting.
  • The user shall be able to choose the resume template before exporting.

Generative AI Resume Services (GAIReS)

  • GAIReS shall have a service to review the profile based on the resume guidelines.
  • GAIReS shall have a service to generate the resume contents based on the given job description.
  • GAIReS shall have a service to take the feedback from the user if any on the generated contents.

Billing system

  • Users shall be billed on usage basis of GAIReS Services.
  • There shall be a model developed for billing of the GAIReS services.

System Level Requirements

UI

  • There shall be a dedicated page for the profile view, creation, modification and deletion.
  • There shall be a dedicated page for users to enter the job description or fetch from the users.
  • There shall be a dedicated page for users to handle the payments redirected from profile.

Database

  • Database shall be available for user profiles and all the information shall be stored.
  • This database shall be able to create, update, read and delete the user profiles and job applications.

AI Services

  • There shall be an AI Service which can review the profile based on standard resume guidelines and provide the feedback.
  • There shall be an AI Service which can review the job description and generate a json resume
  • There shall be an AI Service which can self-correct and accept feedback from the users.

Resume Exporters

  • There shall be a mechanism to choose the resume templates.
  • There shall be a mechanism to export the give resume contents to selected PDFs.

Payment and Billing

  • To be filled later

Component Level Requirements

UI - Profile

  • Users shall be authenticated before performing any kind of profile operations.
  • Users shall be able to create a new profile.
  • Users shall be able to view an existing profile.
  • Users shall be able to update an existing profile.
  • Users shall be able to delete an existing profile.

UI - Resume Creator

  • User shall be able to insert the job description in a dedicated text inputs
  • User shall be able to generate the resume based on the job description and profile contents.
  • User shall have parameters selected for the resume-generation AI services.
  • User shall be able to provide the feedback for the generated resume.
  • User shall be able to modify the generated resume.
  • User shall be able to select the template before exporting.
  • User shall be able to export the resumes to pdf format.

DB - Profile and Job Apps

  • Database shall provide a schema to store the profiles.
  • Database shall provide wrapper functions to perform the database operations.
  • Database wrapper shall allow to create a new profile with default contents.
  • Database wrapper shall allow to read an existing profile.
  • Database wrapper shall allow to update an existing profile.
  • Database wrapper shall allow to delete an existing profile.

AI Service - Profile Reviewer

  • AI service shall be able to read the profile from the database.
  • AI service shall be able to provide the feedback for each of the section in the resume.
  • AI service shall be able to provide the feedback based on the standard profile guidelines selected.

AI Service - Resume Generator

  • AI service shall generate the contents based on standard resume guidelines for the given template.
  • AI service shall choose the projects from work-experience according to the resume guidelines and job description.
  • AI service shall choose the academic projects from educational institutions according to the resume guidelines and descriptions.
  • AI service shall choose the skills such as programming language, tools, technology skills that are relevant to the job description.
  • AI service shall choose the papers if available that are relevant to the job description.
  • AI service shall choose the patents if available that are relevant to the job description.
  • AI service shall choose the talks if available that are relevant to the job description.
  • AI service shall be able to take the feedback from the users on the generated sections and re-generate according to the user-feedback.
  • AI service shall generate resume without any errors in grammar and typos.

Resume Exporter - Templates

  • The resume templates shall be created using Latex.
  • For each of the resume templates, there shall be a dedicated resume guideline.

Resume Exporter - Rendering and Editing

  • Users shall be able to export the resumes to pdfs.

Payment and Billing

  • To be filled later