51 lines
1.4 KiB
Text
51 lines
1.4 KiB
Text
---
|
|
type: template
|
|
name: ajuda-tela
|
|
description: Template canônico para ajuda contextual na interface do usuário (Pilar 2 DDD)
|
|
updatedAt: "2026-09-02"
|
|
---
|
|
|
|
<!--
|
|
DESTINO CANÔNICO NO PROJETO:
|
|
- Co-localizado com o componente Vue correspondente no frontend:
|
|
Ex: Para 'ModalParametros.vue' -> salvar como 'ModalParametros.ajuda.md' na mesma pasta.
|
|
-->
|
|
|
|
# Ajuda: [Nome da Tela / Modal / Formulário]
|
|
|
|
## Objetivo
|
|
<Explicar em linguagem simples e direta para o usuário final qual é o propósito desta tela e o que ela permite realizar.>
|
|
|
|
---
|
|
|
|
## Como Utilizar (Passo a Passo)
|
|
1. **Passo 1:** <Ação do usuário>
|
|
2. **Passo 2:** <Ação do usuário>
|
|
3. **Passo 3:** <Ação de conclusão / salvar>
|
|
|
|
---
|
|
|
|
## Campos e Informações
|
|
|
|
| Campo / Opção | Obrigatório? | O que preencher |
|
|
| :--- | :--- | :--- |
|
|
| **[Nome do Campo 1]** | Sim | <Explicação do valor esperado> |
|
|
| **[Nome do Campo 2]** | Não | <Explicação do valor esperado> |
|
|
|
|
---
|
|
|
|
## Botões e Ações Disponíveis
|
|
|
|
- **[Botão Salvar / Confirmar]:** <O que acontece ao clicar>
|
|
- **[Botão Cancelar / Fechar]:** <O que acontece ao clicar>
|
|
- **[Botões de Ação Específica]:** <O que acontece ao clicar>
|
|
|
|
---
|
|
|
|
## Dicas e Resolução de Dúvidas Frequentes
|
|
|
|
> [!TIP]
|
|
> **Dica Útil:** <Dica prática do dia a dia da operação.>
|
|
|
|
> [!IMPORTANT]
|
|
> **Atenção:** <Ponto de atenção ou regra de bloqueio importante.>
|