Softcom > FAQ: Guia de Padronização para Criação e Gestão de FAQs
Software: HelpTools | Grupo: PROCESSOS
Solução
Observações:
Este guia estabelece os padrões e as boas práticas para a criação, estruturação e manutenção dos FAQs (Frequently Asked Questions) na Softcom, garantindo a qualidade, consistência e eficácia da nossa base de conhecimento.
1. Conceitos Fundamentais
1.1. O que é um FAQ?
A sigla FAQ significa Frequently Asked Questions , ou Perguntas Feitas Frequentemente. Visa responder dúvidas e solucionar problemas comuns de forma clara e objetiva.
1.2. Onde os FAQs são disponibilizados?
No ambiente da Softcom, os FAQs estão acessíveis na agenda, no Helptools e em telas específicas das aplicações Softshop e Softcomshop.
1.3. Qual a finalidade de um FAQ?
Um bom FAQ capacita clientes e técnicos a resolverem situações, das mais simples às mais complexas, de forma autônoma. Isso resulta em:
- Agilidade no atendimento: Reduz o tempo de espera do cliente.
- Disseminação de conhecimento: Padroniza a informação entre os colaboradores.
- Redução de custos: Diminui o volume de chamados para o suporte.
2. Conteúdo e Planejamento
2.1. Sobre o que um FAQ pode ser criado?
FAQs podem ser criados para diversos fins, mas os mais comuns são sobre:
- **Erros:
** Erros de ambiente, preenchimento incorreto ou situações adversas.
Erros específicos de uma versão da aplicação. - Dúvidas:
- Funcionalidades e serviços.
- Integrações e fluxos de trabalho.
- Questões sobre aquisição de produtos.
- Conhecimento técnico geral.
2.2. O que considerar ao criar um FAQ?
- Empatia: Coloque-se no lugar de um novo usuário. O que parece simples para você pode ser complexo para ele.
- Clareza e Objetividade: Use uma linguagem simples e direta. Organize a informação de forma lógica e didática.
- Antecipação: Mapeie a jornada do usuário no produto para antecipar possíveis dúvidas.
- Manutenção: Entenda que os FAQs são dinâmicos. Assim como as aplicações, eles precisam de gestão e revisões contínuas.
**3. Padrão de Estrutura para FAQs
**
Uma estrutura padronizada garante que o usuário encontre a informação de forma rápida e objetiva.
3.1. Título
O título deve ser claro e otimizado para busca. Siga o padrão: Aplicação > Módulo: Descrição da dúvida ou erro
Aplicação: Indica o sistema principal. (Ex.: Softshop ou Softcomshop)
Módulo: Mostra o módulo em questão para fácil localização. (Ex.: NFe ou Venda Mais)
Descrição: Descreve o objetivo do FAQ de forma concisa. (Ex.: Como Emitir uma NFe Avulsa? ou Como Cadastrar um Contato?)
Fiscal > NFCe > CSC: Como gerar ou consultar o CSC - PIAUÍ?
3.2. Cabeçalho
Detalha as restrições, requisitos e observações necessárias que o usuário precisa saber ou ter antes de seguir o passo a passo. Pode ser um texto simples ou uma tabela na cor vermelha para destacar.
* **Requisitos:** Os requisitos são essenciais para informar ao usuário o que é obrigatório antes de iniciar o processo.
Requisitos:
Android 6.0 e versões mais recentes| Google Play (Clique aqui)
Requer o iOS 14.0.0 ou posterior| App Store (Clique aqui)
* Observação: Se um requisito exigir uma configuração prévia, inclua um link para o FAQ ou vídeo correspondente ou inclua orientações em texto para iniciar. * ##### Observações:
O processo de credenciamento no DT-e no estado do Piauí só é necessário caso o cliente ou a contabilidade não tenha acesso ao Portal da SIAT WEB por meio do Certificado Digital.
**3.3. Corpo (Desenvolvimento)
** Onde a solução é apresentada seguindo um padrão estruturado em passos simples e objetivos.
3.3.1. Numeração
Use uma lista numerada para o passo a passo (1., 2., 3., ...);
1. Acessar as configurações do caixa e habilitar o módulo SAT.
3.3.2. Textualização
* Cada passo deve iniciar com um verbo de ação **(Ex: "Acessar", "Configurar", "Marcar")**.1. Acessar as configurações do caixa e habilitar o módulo SAT.
Alinhamento do Texto: O texto deve ser alinhado à esquerda sem nenhuma margem;
Hierarquia de Informação: Use os cabeçalhos (H3, H4, etc.) para organizar o conteúdo hierarquicamente, não apenas para alterar o tamanho da fonte.
Os principais estilos utilizados são:
Normal: Textos sem formatação;
H3: Ideal para Textos em Destaque;
H4: Utilizado para Títulos;
H5: Comum em Subtítulos e Textos;
H6: Para observações não importantes.
3.3.3. Visualização
* Após textualizar o passo a ser executado insira uma mídia visual que ilustre a ação para melhor entendimento. Formatos suportados: **Imagens, Vídeos ou Gifs**. * **1.** Acessar as configurações do Selfhost, preencher os dados do Servidor HTTP e adicionar um novo dispositivo;
- 3.4. Rodapé
- Contém informações auxiliares, como observações importantes ou links para conteúdo complementar.
* **Obs.:** Caso a instalação do SPED .net ocorra na versão mais recente disponível (em matrizes) do Softshop os passos 2 e 3 não se fazem necessários.- Obs.: Para ver o vídeo de como gerar e validar o arquivo (clique aqui).
* **3.5. Palavra Chave**Adicione termos relevantes que o usuário poderia usar para buscar este artigo. Isso melhora a busca do FAQ no sistema.
CSC; Código de Segurança; Token; NFCe; Piauí; SEFAZ; SIAT; Fiscal; PDV;
* **4. Componentes e Estilização (Padrões de HTML/CSS)**
Para manter a identidade visual e a legibilidade mais fluída, utilize os seguintes padrões opcionais de código.
4.1. Upload
4.1.1. Para fazer o upload de mídias nos formatos Imagens, Vídeos ou Gifs use a opção Picture:****
4.1.2. Após clicar no botão vai aparecer a opção de Escolher arquivos.
Imagens devem ser responsivas e conter texto alternativo para acessibilidade.
**
**
**4.2. Links
**
4.2.1. Links devem ser claros e abrir em uma nova aba. Clicar em Link (Ctrl + K):
4.2.2. Após clicar no botão vai aparecer a opção de Inserir Link ;
4.2.3. Marcar a flag Open in new windows e Use defalt protocol ;
Estilo: Cor #3984c6.
Link: FAQ 7502 - Fiscal > DT-e: Como Realizar o Credenciamento DT-e? (Clique aqui)
[FAQ 7502 - Fiscal > DT-e > Como Realizar o Credenciamento DT-e? (Clique aqui)](...)
**4.3. Vídeos
** Vídeos devem ter uma legenda padronizada.
Formato da Legenda:
Categoria: Título do VídeoVídeo de Treinamento: Como realizar o download dos XMLs de NFe no Softcomshop
Reprodução: Indique onde o vídeo está hospedado com link redirecionado (Ex: Softcom Tecnologia).
**
- 4.4. Alertas Importantes**
**Use este código para destacar informações importantes no corpo da FAQ.
Importante! Esse passo cria um backup do arquivo de configuração para resolver possíveis divergências futuras.
**Importante!** Seu texto de alerta aqui.
**5. Modo de Comunicação
** Para garantir consistência, todos os FAQs devem seguir um tom de voz padrão:
Didático: Ensine o usuário. Explique o "porquê" das coisas, se for relevante.
Objetivo: Vá direto ao ponto. Evite rodeios e informações desnecessárias.
Profissional e Acessível: Mantenha um tom respeitoso. Evite gírias, linguagem excessivamente informal ou abreviações internas.
Use a Voz Ativa: "Clique no botão Salvar" em vez de "O botão Salvar deve ser clicado".
- 6. Otimizador de FAQ
Sistema inteligente para otimização de FAQs usando IA
Automatizar a formatação: Otimize seus FAQs automaticamente para seguir os padrões estruturais estabelecidos no guia para criação e revisão de FAQs.
Ganhar agilidade e velocidade: Crie e revise FAQs em tempo recorde. Basta preencher o conteúdo com os passos, imagens e orientações gerais, e deixar que a IA faça o trabalho pesado de organização e otimização.
Focar no conteúdo, não na formatação: Concentre-se em fornecer informações claras e úteis aos seus usuários, enquanto a mágica da IA cuida da estrutura e apresentação.
Simplifique seu processo de FAQ e melhore a experiência com oFAQ Optimizer (Clique aqui)
**
**
**
**
**Como Solicitar a Revisão ou Criação de FAQs?
** Acesse o fluxo de aprovação FAQ 6729 - Softcom>FAQ: Como se dará o fluxo (Diagrama) de renovação da base de conhecimento? (Clique aqui)
Tags: faq, softcom, como criar faq, conhecimento