Skip to content

Melhorar a documentação dos fluxos de dados e dos fluxos de trabalhos dos sistemas do CodeMeistre #1

Description

@micalevisk

Enhancement Request

Pode-se usar este diagrama de sequência como inspiração.

Olhar o sumário das funcionalidades do CodeBench, e a lista de funcionalidades que o front-end implementou


Como forma de facilitar o entendimento operacional sobre o backend da plataforma, faz-se necessário documentar as seguintes operações (ou fluxos), e registrá-los neste repositório:

A lista abaixo será preenchida sob demanda

  • login quando um usuário está desativado 1
  • professor envia convites de cadastro de novos alunos
  • usuário recupera sua senha
  • usuário define uma nova foto de perfil 2
  • anônimo se cadastra como um usuário (aluno), via link de convite emitido previamente por um Staff que foi enviado para seu endereço de e-mail
  • professor cria um trabalho 3
  • professor adiciona um material didático em sua turma
  • usuário ativa4 e desativa5 a tela de bloqueio (lockscreen)
  • usuário interage com a IDE; workflow da autenticação e autorização
  • aluno acessa um exercício de sua turma
  • aluno submete sua solução, que está correta
  • aluno invoca um teste da sua solução, que está correta
  • ...

Footnotes

  1. https://codemeistre.github.io/docs/mermaid-diagrams/auth/login_when_user_is_deactivated.svg

  2. https://codemeistre.github.io/docs/drawio-diagrams/user/upload_new_avatar.svg

  3. https://codemeistre.github.io/docs/mermaid-diagrams/work/staff_create_work.svg

  4. https://codemeistre.github.io/docs/mermaid-diagrams/auth/lock_session.svg

  5. https://codemeistre.github.io/docs/mermaid-diagrams/auth/unlock_session.svg

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    [effort] moderatedeve ter resolução viável.[prio] highdeve ser resolvida na medida do possível.[status] in progressresolução em andamento.[type] documentationse refere a algum processo documentativo.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions