Skip to main content

Bem-vindo aos Manuais

Manuais de usuário — MOC Fidelidade

Manuais completos em pt-BR pra cada um dos produtos da plataforma. Tudo publicado em docs.mocsolucoes.com.br com busca, índice e versão atualizada automaticamente via CI.

Por onde começar

ProdutoVocê é… Pra quemUse… LinkTempo de leitura
AppClienteDono ou gerente da empresa ClienteManual finaldo Admin (acumula pontos/marcações)web) app-cliente.md20 min
AppEmpresaAtendente/operador da empresa OperadoraManual (atendedo cliente no balcão)AppEmpresa app-empresa.md15 min
AdminCliente (web)final OperadoraManual (gerenciado tudo pelo navegador)AppCliente admin.md8 min

Quick start: admin.md#primeiro-acesso — em 5 passos seu programa de fidelidade está no ar.

    Cadastrar primeira empresa: admin.md#primeiro-acesso Gerar QR Code pra colar no balcão: admin.md#qr-code-da-empresa Convidar operadores da equipe: admin.md#operadores Criar primeira recompensa: admin.md#recompensas Trocar/escolher um plano: admin.md#plano-e-faturas Como o cliente acumula: app-cliente.md#vincular-empresa Operação no balcão (gerar código de marcação/pontos): app-empresa.md#gerar-codigo Configurar pagamento (PIX/boleto/cartão): admin.md#pagamento Reembolso ou cancelamento de conta: admin.md#encerrar-empresa

    Treinamento ao vivo

    Empresas em plano Pro ou superior têm direito a 1h de treinamento em vídeo no primeiro mês de contrato. Para agendar, abra ticket em Suporte > Treinamento dentro do painel ou escreva pra contato@mocfidelidade.com.br.

    Para quem escreve / contribui

    • Linguagem acessível — evita jargão técnico, explica conceitosconceito quando necessário.precisa.
    • Foco em tarefa: ("como fazer X") em vez de "featuredescrição Yde existe".feature.
    • Screenshots podem ser adicionadas depois —depois; manuais são auto-suficientes em texto puro pra serem renderizados como markdown em qualquer lugar.

    Versionamento

    Os manuais devem ser atualizados sempre que houver mudança de UX ou fluxo. Em particular:

    • QuandoFeature entranova umaentrou featureem nova.produção.
    • Quando muda passoPasso a passo de algo já documentado.documentado mudou.
    • Quando muda mensagemMensagem de erro descrita no FAQ.mudou.

    Toda alteração em docs/manuais/*.md é sincronizada automaticamente pra BookStack (docs.mocsolucoes.com.br) e Wiki do GitLab via pipeline CI.

    Distribuição

    • Online:Online (recomendado): odocs.mocsolucoes.com.br site (mocfidelidade.com.br/ajuda)sempre podena renderizarúltima essesversão, com busca e formatação rica.
    Site institucional: linkado na seção FAQ.md. Dentro do app:Admin: futuramente,menu telaslateral "Ajuda"Suporte podem> incluirManuais. linksGitLab prosWiki: tópicosespelho relevantes.versionado pra time interno. Markdown bruto: este diretório, pra leitura em editor ou IDE.