> ## Documentation Index
> Fetch the complete documentation index at: https://docs.weve.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Mentorias

> Agenda, crédito e prontuário de quem acompanha alguém de perto.

A mentoria é o acompanhamento de uma pessoa por outra: sessões marcadas numa agenda, um saldo de
sessões que a compra dá, e o que se combina entre uma sessão e outra. Ela pode ser individual,
em grupo, ou as duas coisas na mesma mentoria.

## Quem tem direito

A mentoria é um **entregável**, como o curso: o `id` dela é o que se põe numa entrega. Quem tem
direito a ela é quem tem uma matrícula ativa numa entrega que a abre — e por isso reembolso,
prazo de acesso, bônus de turma e entrega aberta funcionam sem configuração nenhuma a mais.

O que é da **pessoa** dentro da mentoria — o mentor designado, a etapa do quadro, as sessões, as
metas — continua existindo depois que o acesso acaba. Quem só tem histórico lê tudo o que é dele
no classroom; o que não consegue mais é reservar.

## O crédito

Cada matrícula que abre a mentoria traz uma **cota**:

| `quota_kind` | significa                                                        |
| ------------ | ---------------------------------------------------------------- |
| `total`      | `quota` sessões durante o acesso — o pacote                      |
| `monthly`    | `quota` sessões por ciclo mensal, contado do início da matrícula |
| `unlimited`  | sem teto                                                         |

A cota é a da mentoria, a menos que a entrega tenha uma própria
([`PUT .../deliveries/{deliveryId}/quota`](/api-reference/mentorships/quota-set)). É assim que o
pacote de 4 e o de 12 viram a mesma mentoria, com o mesmo mentor e o mesmo prontuário.

O saldo **não é um número guardado**. Cada inscrição numa sessão aponta para a fonte que
consumiu — uma matrícula, ou uma [concessão avulsa](/api-reference/mentorships/credit-grant-create) —,
e o saldo é a conta disso. Duas compras são dois créditos, e mudar a cota da mentoria vale para
todo mundo a partir do instante da mudança.

A reserva gasta primeiro o que acaba primeiro: a matrícula ilimitada, depois as matrículas pela
data de fim (a vitalícia por último), e só então as concessões avulsas, que não vencem.

<Note>
  A cota mensal conta no ciclo da **sessão**, não no da reserva: reservar hoje uma sessão para o
  mês que vem gasta o crédito do mês que vem.
</Note>

O que consome: a inscrição de pé, a **falta** marcada, e o cancelamento feito pelo aluno dentro
do prazo de aviso da mentoria (`cancel_notice_minutes`). O que devolve: desmarcar com
antecedência, e qualquer cancelamento feito pela equipe.

## A agenda

A agenda de cada mentor é uma **semana** em hora local, no fuso do perfil dele
([`PUT .../availability/rules`](/api-reference/mentorships/availability-rules-set)), mais
**exceções** em instantes absolutos: `blocked` tira um período, `extra` acrescenta um. "Segunda das
9 às 12" continua sendo 9h no relógio de Lisboa depois do horário de verão.

Os horários livres são **calculados na leitura**: as janelas da semana, somadas às exceções `extra`,
descontadas dos bloqueios e das sessões já marcadas. Dentro de cada janela os começos andam de
`slot_step_minutes` em `slot_step_minutes`, a partir do começo dela; um horário vale se a sessão
inteira cabe na janela e se a sessão mais o respiro (`buffer_minutes`) não encosta em outra.

Não existe linha de horário reservado. O que impede duas reservas no mesmo horário é o próprio
banco: a mesma pessoa não conduz duas sessões que se sobrepõem — em mentoria nenhuma, em club
nenhum. Um horário da lista pode ser tomado antes do clique, e a reserva responde `409 slot_taken`.

## As sessões

| formato      | quem cria                                    | quem participa                           |
| ------------ | -------------------------------------------- | ---------------------------------------- |
| `individual` | o aluno reservando, ou a equipe em nome dele | uma pessoa                               |
| `group`      | a equipe                                     | até `capacity` pessoas, que se inscrevem |

A sessão em grupo pode não consumir crédito (`consumes_credit: false`) — o hot seat que o programa
dá à vontade. A individual marcada pela equipe também, e aí é a sessão de cortesia.

O estado da sessão é **derivado do relógio**: `upcoming`, `in_progress`, `ended` ou `cancelled`.
Não há "concluir" a clicar — a sessão que terminou sem cancelamento e sem falta aconteceu, e é aí
que o pedido de avaliação sai.

O endereço da sala é o da sessão, ou o do perfil de quem conduz, lido na hora: trocar o link do
perfil vale para as sessões já marcadas.

## O prontuário

* **Anotações** são da equipe, sempre. O que o aluno lê é o **resumo** da sessão (`summary`, em
  markdown), que é outro campo — separar os dois por campo, e não por uma opção de "compartilhar",
  é o que impede uma anotação privada de chegar ao aluno por um clique.
* **Metas e tarefas** são uma lista só. O **playbook** é um modelo: aplicá-lo cria uma meta com as
  tarefas dele copiadas, e o prazo relativo de cada uma vira data. Editar o playbook depois não
  mexe no que foi aplicado.
* **Recomendações** apontam para um curso ou uma aula do club, e o "já viu" é o progresso do aluno.
  Recomendar não abre nada: quem não tem o curso vê a recomendação trancada.
* **Etapas** formam o quadro de quem mentora. São da equipe, não decidem acesso e ficam no histórico
  a cada mudança.

## Quem mentora

Mentorar é um **perfil**, não um papel no club: qualquer pessoa do club pode mentorar. Quem
administra vê todas as mentorias e todos os mentorados; quem só mentora vê as mentorias que atende
e, dentro delas, as pessoas designadas a ele.

## Os avisos

Por e-mail, com o convite de calendário (`.ics`) anexo quando a agenda de alguém muda:

| aviso                                   | para                | desligável                    |
| --------------------------------------- | ------------------- | ----------------------------- |
| sessão confirmada, remarcada, cancelada | aluno e quem conduz | não                           |
| lembrete um dia antes e uma hora antes  | aluno e quem conduz | `notify_mentorship_reminders` |
| pedido de avaliação                     | aluno               | `notify_mentorship_reminders` |
| tarefa nova                             | aluno               | não                           |
| mentorado designado                     | quem mentora        | não                           |

O aviso é conferido na hora de sair: a sessão cancelada entre o agendamento do lembrete e o envio
dele não gera lembrete.

## Os arquivos

A gravação de uma sessão e o material de um mentorado são enviados por
[`/mentorship-files`](/api-reference/mentorships/file-create): ficam **privados**, fora da
biblioteca, e são apagados do armazenamento junto com o dono. Mídia da biblioteca também pode ser
anexada, e aí é só apontada.

Com a [marca d'água](/essentials/watermark) ligada, o PDF entregue ao aluno sai carimbado com o
nome e o documento dele, como o material de uma aula.

## Remoção do aluno

Remover um aluno desmarca as sessões por vir (a individual é cancelada, e quem conduz é avisado),
redige a pauta, o comentário da avaliação e o motivo das concessões, e apaga anotações, metas,
tarefas, recomendações, os arquivos dele e o resumo e os arquivos das sessões individuais. As
notas da avaliação ficam: são números, e a média de quem mentora depende delas.


## Related topics

- [Listar mentorias](/api-reference/mentorships/list.md)
- [Mentorias do aluno](/api-reference/mentorships/classroom-list.md)
- [Quem mentora](/api-reference/mentorships/mentors-list.md)
- [Prontuário](/api-reference/mentorships/participant-get.md)
- [Anotar](/api-reference/mentorships/notes-create.md)