HTML Help

De Tek-System Wiki
Ir para navegação Ir para pesquisar

Padrões do Help do Sistema (Shift F1)

1. Tipo e tamanho de letra: Verdana / 2

     •	Tipo: Verdana 
     •	Tamanho: 2 

2. Nome atribuído aos HTMLs:

   a.	Nome dos Menus: Nome do Formulário. 
     • Para identificar o nome dos arquivos HTML acesse a tela no sistema e pressione Ctrl + Alt + F5. 
     •	Não esqueça de vincular os Menus no Mapeamento. 
     •	Nome das imagens: Nome do formulário seguido de número. 
   b.	Quando for Help de rotina não vinculada à menu, adote a seguinte estrutura para o nome: Prefixo Rotina, mais o Verbo, mais o Nome do Processo. 
     •	Utilizar Underline para preencher espaço. 
     •	Utilizar somente letras e números. (Sem caracteres especiais, til, acento).
       Exemplos:
       Processo	                      //     Nome do Formulário
       Como calcular de Depreciação	  =  Processo_Calcular_Depreciacao
       Como emitir NFSe                   =  Processo_Emitir_NFSe
       Como gerar o registro 1400 do SPED =  Processo_Gerar_Registro1400_SPED
       Como controlar Cartão de Crédito   =  Processo_Controlar_CartaoDeCredito

3. Evitar mencionar legislação.

     •	Para não induzir interpretações legislativas.
     •	A legislação não é estável, e as mudanças legislativas tornariam defasadas as informações do help. 

4. Sobre Imagens:

     •	Utilizar mecanismos que favoreçam upload.

5. Informações:

     •	No cabeçalho, informar a data da atualização.