Padronização da Wiki para a Documentação

De wiki.eliteSoft.com.br
Ir para: navegação, pesquisa



« Voltar | « Principal


BarraAmarela.png Lampada.png Deve informar para qual a atualização que este documento se refere, Changelog versão 5.03.00.


Padrão para Documentação - Web, Desktop, Mobile e Central do Assinante, insira o Título para esta documentação

Objetivo.jpg Insira o objetivo e qual o motivo da implementação.


Permissão
Insira a permissão ou variável que foi elaborada para este procedimento.


1) A documentação inicia com a configuração (permissão, variável ou configurações que são necessárias) para o procedimento e a imagem do Integrator para a conduta da documentação.

Http.png - imagem com formato .png

Caminho a Seguir: ISP - INTEGRATOR...salientando qual a trilha no Integrator para chegar a imagem.


1.1) A sequência inserida (1.1; 1.2...) depende de qu


1.2) Quando for estabelecer o link, utilizar palavras-chaves e sem abreviação, para saber do que se trata a documentação;


1.3) Não usar acentuação;


1.4) Para cada palavra, inserir um _ (underline) para produzir o link.


Para Elaborar o Link da Documentação de Projeto

2) Inserir o nome abreviado com o código, do projeto que está em execução (Ex.: FC_43 = Ficha Contratada 43 ou AG_5 = Ágil 5);


2.1) Módulo da implementação (Ex.: ModuloDesk, ModuloWeb), palavras juntas e a letra inicial maiúscula para palavras diferentes;


2.2) Código do Cliente no Integrator;


2.3) Número do Protocolo do Atendimento;


2.4) Descrição da Implementação: poderá ser escrito com acentuação e cedilha e palavras separadas por _ (underline) com letra maiúscula para palavras principais.


Organização da Página

3) Logotipo da EliteSoft no início da página e centralizado.


3.1) Inserir na sequência o botão Voltar e Principal para retornar ao primeiro vínculo da página ou a página principal da Wiki.

Ex.: [[Página.jpg|« Voltar]] | « Principal


A Página Deverá ser Exibida com Destaque para os Pontos Importantes do Documento

BarraAmarela.png Lampada.png Para a versão de Changelog, inserir esta caixa de leitura. A mensagem deverá ser: Esta alteração estará disponível para o Changelog e a versão, sem previsão definida no momento.


4) Para informações ao CE, a documentação tem pontos que deverão vir com destaque para visualização;


Objetivo.jpg Inserir um comentário informando do que se trata o documento.


4.1) Para as telas bloqueadas inserir esta caixa de mensagens para melhor entendimento;

BarraLaranja.png Cadeado.png Destacar telas bloqueadas.


4.2) Para destacar alerta ou advertência para pontos que não podem ser alterados ou podem ser usados somente da forma que estão.

BarraVermelha.png AlertaVermelha.png Aviso e alerta da página.

Imagem

5) A imagem deverá ficar do lado esquerdo da página;


5.1) Caso a ilustração seja maior que a tela, deverá ser DE ATÉ 1000 pixels. (Ex.: [ [Arquivo:Exemplo.jpg|860px] ]);


5.2) A imagem deverá ter ênfase com círculo: (Ex.: Circulo12.png) nas partes importantes, para melhor visualização;


5.3) A imagem deverá ser enquadrada (Ex.: Quadrado123.png) para salientar a representação;


5.4) Colocar o caminho que foi retirada a imagem do Integrator, logo abaixo da ilustração. (Ex.: ISP - INTEGRATOR / PAINEL DE CONFIGURAÇÕES / PLANOS E SERVIÇOS)


Formatação do Documento

6) O Título do documento deverá ser (Ex.: Exibir.png);


6.1) Os documentos devem vir numerados;


6.2) Quando houver documentação maior que uma página, incluir o botão Topo no rodapé (Ex.: Content.png);


6.3) O Changelog deverá ser referenciado na categoria da página como (Ex.: Changelog121.png).

  • Os campos com títulos devem estar entre == dois iguais == para dar destaque ao título;
  • Tela: proteger a tela criada ou atualizada; e quando for explicar alguma alteração, colocar em negrito;
  • Botão: ao explicar a existência de um botão na tela, deverá estar em negrito;

Exemplo: Observação.jpg

Obs.: Após lidas as observações, clicar no botão Fechar Tela.

  • Ícone ou Menu: quando indicar este botão deverá estar em negrito;
  • Campo ou Tela ou Item: quando for explicar a alteração de um campo, colocar em negrito;

Exemplo: Campo.png

Obs.: Na opção Campos Extras, é possível editá-lo clicando no botão Editar Campo;

  • Aba: quando indicar uma aba, colocar em negrito;
  • Para novas telas: usar o termo "Exibirá";
    • Ex: Exibirá a tela Novo Cliente, no item Validação do Cliente;
  • Todos os campos que estiver em vermelho, estão aguardando orientação e não foram preenchidos definitivamente e/ou são páginas em fase de elaboração;
  • Para RadioButton: usar a expressão "Marcar";
  • Para selecionar algum botão: Usar a expressão "selecionar a opção “Salvar”";
  • Para Checkbox: usar a expressão “Marcar”;
  • Palavras em outros idiomas (inglês, espanhol e etc), deixar em itálico;
  • Mensagem: quando mencionar uma mensagem colocar “entre aspas” (mensagem: “Mensagem”);
  • Quando inserir uma imagem, no campo “Comentário”, passar o caminho da imagem no sistema;
    • Ex.: CliAtendScrImp (Clientes-> Atendimentos -> Script de Importação)
    • Não acentuar, não utilizar ç..., na descrição do comentário
  • Termo para duplo clique: dar um clique duplo;
  • Usado para comentários nas páginas = Comentario.png;
  • Termo para utilização do botão direito: “Clicar com botão direito do mouse”;
  • Numa condição, utilizar a frase: "Caso queira"/ "Caso necessário"/ "Caso contrário".
  • Utilizar Siglas/Abreviações/Acrônimo quando não tiver espaço.
    • Ex.:Inscrição Estadual: I.E.
    • E-mail (Label e texto corrido)
    • texto em vermelho será mostrado como texto em vermelho
    • texto em verde será mostrado como texto em verde
    • texto em azul será mostrado como texto em azul
  • Legenda
Legenda
Pendente Contas Pendentes
Quitadas Contas Quitadas


Tratamento de Imagens

As bordas dos ícones

  • Retângulo arrendondado
  • Tamanho 5px
  • Cor vermelho

Botões

  • Retângulo Arrendondado
  • Tamanho 3px
  • Cor vermelho

Tela dentro da Tela

  • Retângulo
  • Tamanho 3px
  • Cor vermelho

Alinhamento de Texto

Sua sintaxe é: Comentario1.png

- Os tipos de alinhamento possíveis são estes:

  • center (centralizar);
  • left (esquerda);
  • right (direita);
  • justify (justificado).


Tratamento de Acrescentar um Link Interno e/ou Externo

  • Link Interno - Para adicionar um link interno, deverá encontrar a página que será reproduzida. Por exemplo: Copialink.png e para definir um local na página para o qual queira ir, use a marca Nome145.png, criará uma âncora que define aquele local na página. Use um dos exemplos: Nometexto.png dentro da mesma página , ou Nomepagina.png para um local em outra página.

Tratamento de Acrescentar Vídeos do Youtube

Para adicionar um link do Youtube no documento, deve-se definir o vídeo que quer anexar e empregar onde está referenciando como exemplo.

Youtube.png

Para inserir a imagem e essa imagem for chamar o link do Youtube, adicione o link Objeto.pngpara mostrar esta imagem Icfitavideo.png, que será o link do seu documento.

Para fazê-lo funcionar basta seguir este exemplo: Video.png

Tratamento de Páginas Internas

Documentação Interna - Layout

  • Para criar uma página na documentação interna, é necessário que a página seja criada sem espaços e sem acentuação, devido a restrição.

Segue o modelo abaixo como deve ser criado a página.

Layoutpaginterna.png

Veja que ao acessar a página, o nome da página ficará no padrão.

Layoutinterno.png


Toda página pode ter um apelido

Todo apelido de página será igual ao link, na mesma linha separadas pelo '"|"'(Pipe) e, qual o projeto, o código do projeto, a descrição (Módulo Desktop, Web, Central do Assinante ou Mobile), o código do cliente, o protocolo de atendimento e a descrição da implementação, todas as palavras separadas por underline (_), terão a seguinte característica:

Exemplo:
Nomenclatura1.png


Manual

Anotações importantes:

  • Alterar Sidebar

Link para fazer a alteração na Barra de Navegação - http://wiki.elitesoft.com.br/index.php/MediaWiki:Sidebar

  • Registro de Eliminações

Link para verificar as eliminações nas páginas ou páginas eliminadas - http://wiki.elitesoft.com.br/index.php/Especial:Registro/delete


Ver Também


Topo