2. Visão Geral - gentil-eilison/Ankit-Backend GitHub Wiki

Visão Geral

Esta seção tem como objetivo mostrar a visão geral do sistema através de um documento de visão geral.

Responsáveis

1. ADS5V

Líderes de Projeto

Irlan Arley Targino Moreira e Demétrios Araújo Magalhães Coutinho

Desenvolvedores

Gentil Ályson Jácome Fernandes e Gentil Kadson Jácome Fernandes

Documento de Visão do Sistema

1. Objetivo

O propósito deste documento é coletar, analisar e definir as necessidades de alto-nível e características do sistema Ankit - Plataforma de Criação de Flashcards de Idiomas, focando nas potencialidades requeridas pelos afetados e usuários-alvo, e como estes requisitos foram abordados no sistema. A visão do sistema documenta o ambiente geral de processos desenvolvidos para o sistema, fornecendo a todos os envolvidos uma descrição compreensível deste e suas macro-funcionalidades. O Documento de Visão do Sistema documenta apenas as necessidades e funcionalidades do sistema e deve ser alterado ao término de cada projeto de software.

2. Descrição do Produto

O sistema se resume a uma aplicação web que irá servir como um chat, através do qual os usuários irão conseguir solicitar para o assistente alguma palavra ou tópico sobre o qual ele quer aprender em um determinado idioma. A partir dessa entrada, o chat irá criar flashcards em um formato, para que os usuários consigam adicionar os cartões ao software de repetição espaçada (spaced repetition software - SRS) Anki de maneira semi-automática, agilizando o processo mecânico da criação deles e concentrando as informações do vocabulário ou tópico de aprendizado do estudante em um único sistema.

3. Envolvimento

3.1. Abrangência

O sistema abrange todos os estudantes que utilizam o Anki no seu dia-a-dia para estudos de qualquer idioma de modalidade oral-auditiva.

3.2. Papel dos Atores

3.2.1. Google Login API
Descrição API responsável por gerenciar o login no sistema
Papel Gerenciar o login do usuário e seus dados pessoais, utilizando o protocolo OAuth2 para se comunicar com o Ankit
Representante Google.
3.2.2. ChatGPT
Descrição Modelo de inteligência artificial que gera texto como resposta a partir de entradas do usuário
Papel Receber entradas dos estudantes, que irão conter comandos para gerar flashcards de um assunto ou termo específico em um idioma e retornar a definição ou definições para os termos do tema.
Representante Chat GPT, disponibilizado pela OpenAI.
3.2.3. Estudante
Descrição Estudante cadastrado no sistema que utiliza o Anki para fazer flashcards nos seus estudos
Papel Criar conta; utilizar o chat para indicar o tópico de vocabulário ou palavra específica sobre o qual deseja aprender para criação dos modelos de flashcards; utilizar CSV gerado pelo Ankit para a adição de cards a qualquer baralho; ver estatísticas sobre seu aprendizado, como: número de flashcards adicionados, quais idiomas estou estudando, entre outros.
Representante Estudante de idiomas autodidata ou matriculado em alguma instituição.