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

Você é… Use… Tempo de leitura
Dono ou gerente da empresa Manual do Admin (web) 20 min
Atendente/operador da empresa Manual do AppEmpresa 15 min
Cliente final Manual do AppCliente 8 min

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

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 conceito quando precisa.
  • Foco em tarefa ("como fazer X") em vez de descrição de feature.
  • Screenshots podem ser adicionadas 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:

  • Feature nova entrou em produção.
  • Passo a passo de algo já documentado mudou.
  • Mensagem de erro descrita 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 (recomendado): docs.mocsolucoes.com.br — sempre na última versão, com busca e formatação rica.
  • Site institucional: linkado na seção FAQ.
  • Dentro do Admin: menu lateral Suporte > Manuais.
  • GitLab Wiki: espelho versionado pra time interno.
  • Markdown bruto: este diretório, pra leitura em editor ou IDE.