Aqui uma explicação resumida sobre a rotina.
Ao criar um artigo, vale observar que:
No Tíulo informamos o nome da tela da rotina ou do relatório para fácil identificação.
No Resumo do Artigo informamos um breve resumo do que se trata a rotina ou relatório.
E no Conteúdo do Artigo deve-se citar inicialmente o menu de acesso a rotina ou relatório, para ser localizado no MasterSGi ou SGFlex, dessa forma:
Menu: Menu > Submenu
Obs.: Não é necessário citar o "Incluir/Alterar/Consultar", pois geralmente toda rotina tem essas opções de menu. Então ao invés de citar Cadastros > Filiais > Alterar, cite apenas Cadastros > Filiais
Caso julgar necessário incluir alguma observação adicional sobre a rotina ou relatório, pode-se incluir antes da imagem.
Aqui um PRINT da tela
Em seguida, cite os campos da tela com uma breve explicação do que se trata cada campo.
Campo 1: Descrição do Campo 1
Campo 2: Descrição do Campo 2
Campo 3: Descrição do Campo 3
Obs.: Sempre que citar uma outra rotina que consta o artigo no Ajuda, inclua um link para navegar até a respectiva rotina na mesma janela (Abrir link em... Janela Atual).
Utilizar a imagem da lâmpada para dicas e sugestões
Utilizar a imagem da exclamação para alertas de atenção
Pode-se criar um GIF para demonstrar a utilização de uma rotina, por exemplo: Gerar uma chave de API na plataforma de integração e-commerce. Para criação do GIF, grava-se o vídeo o converte para GIF no site https://convertio.co/pt/
Também é válido incluir informações sobre dúvidas frequentes que ocorrem no Suporte da OCTO.
Informações adicionais para os artigos de Relatório:
Deve-se incluir logo após informar o caminho (menu) do relatório, a possibilidade de visualização do mesmo, dessa forma:
Para visualizar um exemplo do Relatório A em PDF, clique aqui.
Em "clique aqui" insira um link para ver o relatório em uma nova aba do navegador (Abrir link em... Nova Janela).
Para gerar o link do PDF, acesse:
https://www.calameo.com/#login
usuário: suporte@octoti.com.br
senha: @octo@2024
Clique em PUBLICAR AGORA! e Selecione um arquivo do seu computador, depois de carregar o PDF, acesse as Publicações onde estará disponível o link do relatório, basta copiar e colar a URL no link do artigo.
Obs.: O relatório pode ser emitido em qualquer ambiente de teste com dados fictícios e não deve ter conter mais do que 3 páginas.
E ao final do artigo do relatório, inclua a origem dos dados do relatório, dessa forma:
Origem de dados: Aqui será possível visualizar a origem dos dados apresentados no relatório.
Aqui um PRINT da tela de Origem dos Dados
Caso tenho vídeo disponível sobre a rotina, pode-se incluir um link em Vídeo.
Selecione a Sub-Categoria a qual pertence o artigo.
Pode-se definir o Tipo Rascunho até que o artigo esteja realmente pronto para ser lido pelos colaboradores e clientes e Finalizado quando pronto.
Para finalizar, inclua as Permissões Vinculadas onde será exibido através do Saiba Mais os artigos relacionados a rotina ou relatório que o usuário está acessando. Para isso, estando na tela do sistema, clique com o botão direito do mouse e escolha a opção Exibir código fonte do frame, será exibido em uma nova aba e basta copiar o final da URL conforme mostrado abaixo: