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.

Produto Pra quem Link
AppCliente Cliente final (acumula pontos/marcações) app-cliente.md
AppEmpresa Operadora (atende cliente no balcão) app-empresa.md
Admin (web) Operadora (gerencia tudo pelo navegador) admin.md

Para quem escreve

  • Linguagem acessível — evita jargão técnico, explica conceitos quando necessário.
  • Foco em tarefa: "como fazer X" em vez de "feature Y existe".
  • 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:

  • Quando entra uma feature nova.
  • Quando muda passo a passo de algo já documentado.
  • Quando muda mensagem de erro descrita no FAQ.

Distribuição

  • Online: o site (mocfidelidade.com.br/ajuda) pode renderizar esses .md.
  • Dentro do app: futuramente, telas "Ajuda" podem incluir links pros tópicos relevantes.