Guias embutidos (Guias de utilização)
Pré-requisitos de acesso
- Permissão (módulo):
manageToken— o grupo inteiro de guias herda essa permissão (requiredModules: [manageToken]no menu). - Licença/Feature: Nenhuma.
- Contêiner do menu: GERAL → grupo Guias (ícone "livro")
O que é / quando usar
Os Guias de utilização (/usage-guides) são páginas de ajuda estática embutida no próprio BackOffice. Não consomem backend — o conteúdo é texto internacionalizado (chaves usageGuides.* nos arquivos i18n). Servem de referência rápida dentro da ferramenta para operadores que lidam com tokenização e fluxos relacionados, complementando (não substituindo) este Manual do Operador.
A tela tem duas visões:
- Grade (
/usage-guides): cards de todos os guias disponíveis. - Detalhe (
/usage-guides/:id): abre o guia escolhido em seções estruturadas (Visão geral, Pré-requisitos, Passos, Dicas, Seções da tela, Botões/Ações, Campos) e, ao final, links rápidos que navegam direto para a tela real correspondente.
Pré-condições
- Permissão:
manageTokenna role do operador (permissão dupla — enum CPM no backend + módulo dinâmico no DB). Sem ela, o grupo Guias não aparece no menu. - Licença/Feature: Nenhuma.
- Dependências de outras telas: Nenhuma — é conteúdo estático. Os "links rápidos" no fim de cada guia, porém, levam a telas que têm suas próprias permissões/licenças.
Guias disponíveis
São seis guias (cada um é uma rota e um item de submenu):
| Guia | Rota | Foco | Documentação completa neste manual |
|---|---|---|---|
| Tokenização | /usage-guides/tokenization | Visão geral do fluxo de tokenização (conceitos, pré-requisitos, passos). | Tokenização / páginas de Tokens |
| Gerenciar Tokens | /usage-guides/manage-tokens | Criar/editar tokens, cotação, pares de swap. | Gerenciar Tokens (grupo Tokenização) |
| NFTs | /usage-guides/nfts | Criação e gestão de NFTs e coleções. | Gerenciar NFTs / Coleções |
| Crowdfunding | /usage-guides/crowdfunding | Criação de ofertas e ordens de crowdfunding. | Crowdfunding |
| Distribuições Financeiras | /usage-guides/financial-distributions | Distribuir tokens/valores aos detentores. | Distribuir Tokens / Pagamento em Massa |
| Detalhes do Usuário | /usage-guides/user-details | Como ler a tela de detalhes do usuário. | Detalhes do usuário |
Estrutura de um guia (visão de detalhe)
Cada guia é montado a partir de uma lista de seções tipadas no componente. Os tipos de seção possíveis são:
| Seção | Ícone | O que traz |
|---|---|---|
overview | flag | Visão geral / propósito da funcionalidade. |
prerequisites | checklist | O que precisa existir antes (permissões, dados, dependências). |
steps | lista numerada | Passo a passo da operação. |
tips | dica | Boas práticas e cuidados. |
sections | layout | Explicação das seções/áreas da tela real. |
buttons | botões | O que cada botão/ação faz. |
fields | campos | Significado dos campos do formulário. |
No rodapé do detalhe, o bloco Links rápidos (links) renderiza botões que navegam para as telas reais (ex.: o guia de NFTs aponta para /manage-assets).
Ações e modais
- Abrir guia (card → "Abrir"): navega para
/usage-guides/:ide troca para a visão de detalhe. - Voltar: botão no cabeçalho do detalhe que retorna à grade (
/usage-guides). - Links rápidos: atalhos para a tela operacional correspondente. Atenção: o atalho não concede permissão — se o operador não tiver o módulo/licença da tela de destino, ela não abrirá normalmente.
Regras de negócio / cuidados
Atenção
- Conteúdo estático, sem backend. Os guias não refletem o estado atual dos dados nem validam nada; são texto de ajuda. Em caso de divergência entre um guia embutido e o comportamento real da tela, a tela e este Manual do Operador prevalecem.
- Manutenção via i18n. Atualizar um guia significa editar as chaves
usageGuides.*empt-br.json,en.jsonees.json— toda alteração precisa das três línguas (regra de i18n do projeto). - Visibilidade amarrada a
manageToken. Operadores sem esse módulo não veem os guias, mesmo que tenham acesso às telas-fim por outros módulos.