Skip to content

Documentação Técnica

Documentação técnica da plataforma de estudos HÉLICO — metodologia, plataforma, operação e glossário.

HÉLICO

Plataforma de estudos para concursos jurídicos: um Moodle estendido pelos plugins da HÉLICO, com frontend desacoplado para o Roteiro de Estudos e integrações comerciais para catálogo, transações e concessão de acesso.

Do que esta documentação trata

Ela registra como a plataforma funciona e por quê — a decisão antes do código. Reúne quatro coisas que costumam viver separadas e aqui andam juntas, porque uma depende da outra:

  • a metodologia de ensino que a plataforma materializa, com os conceitos e as regras de adaptação que o motor executa;
  • a arquitetura e as especificações de cada domínio do sistema: conteúdo, produto, motor de estudos, métricas, plataforma e API;
  • a operação na prática, em tutoriais para quem cria conteúdo e para quem administra;
  • o vocabulário canônico do projeto, do qual o glossário é derivado automaticamente.

É documentação interna, de engenharia e de conteúdo: pressupõe acesso ao código e trata de decisões ainda em aberto. O código do plugin vive em middag-io/moodle-local_helico; a documentação voltada ao público externo fica em docs.helico.com.br.

Por onde começar

  • Metodologia

    Conceitos, premissas, fluxos de aprendizagem, regras de adaptação e a estrutura pedagógica do conteúdo. É o ponto de partida: o resto da documentação implementa o que está aqui.

  • Plataforma

    Arquitetura por domínio, decisões registradas (ADRs), contratos de API, integrações e guias de desenvolvimento.

  • Operação

    A operação na prática: tutoriais para gestores e conteudistas.

  • Glossário

    Os termos oficiais da plataforma, da metodologia, do produto e da operação — a mesma fonte que nomeia classes e tabelas no código. Inclui a Árvore Conceitual e as Afirmações Ontológicas.

Contribuir

O processo de alteração da documentação, incluindo o cadastro de termos oficiais e a geração do glossário, está em Contribuição. O glossário e os artefatos de termos são gerados: edite o catálogo, nunca a saída.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close