Índice

Objetivo

Orientar os squads sobre o saneamento do TDN, na Base de conhecimento, restrito às páginas entre 2012 e 2016.

A data final para o saneamento é 31/12/2021. Após esta data, a Base de Conhecimento será removida da space Protheus.

O saneamento do TDN está sendo acompanhado pelas Engenharias Corporativa e Protheus.

Introdução

O  padrão de qualidade de uma documentação não se limita apenas aos cuidados com o conteúdo, mas também, com a formatação das páginas utilizadas para a sua construção.

Neste sentido, a documentação para os sistemas TOTVS compreendem um padrão corporativo e, de acordo com este padrão, os documentos devem ser desenvolvidos para que a experiência do cliente seja a mais positiva possível. 

Espera-se que a documentação disponibilizada para os clientes internos e externos sejam claras, objetivas, seguindo o padrão de qualidade que representa a empresa e, principalmente, que agreguem conteúdo ao produto.

Com o objetivo de melhorar o auto-atendimento de busca das informações no TDN, faz-se necessário o saneamento das páginas antigas e desatualizadas,  pois muitas vezes geram dúvidas e causam situações de erro para os clientes do Protheus.

Procedimentos

Para realizar o saneamento, as páginas válidas devem ser movidas para a pasta de Documento de Referência do módulo, que contém toda a documentação perene sobre o módulo.

Na pasta de Documento de Referência do módulo, há sub-pastas comuns e, outras, que são específicas para cada módulo.

As sub-pastas comuns já foram criadas pela Engenharia Protheus, sendo: Conceitos, Configurações, Controle de Dados Protegidos, Integrações, Menu do Módulo e Pontos de Entrada.

Outras sub-pastas podem ser criadas pelos squads, quando necessário. Recomenda-se agrupar os assuntos em sub-pastas, a fim de reduzir o número das mesmas e organizar da melhor maneira as documentações. 

Além dos assuntos, as documentações também podem ser diferenciadas quanto ao acesso, interno ou externo. Para isto, basta utilizar o recurso de Restrições.

As sub-pastas que forem criadas devem seguir a seguinte regra de nomenclatura: Descrição - Nome do módulo - P12

Observação: Caso um conteúdo esteja todo contido em uma página, não há necessidade de criar uma sub-pasta para o mesmo. 

Exemplo:

Opção Mover

É possível mover uma página ou uma pasta.



Boas práticas

  1. Observe se a estrutura da página onde se encontra o documento está correta e publicada.
  2. Recomenda-se, fortemente, a estrutura das páginas divididas por assuntos comuns. Isto facilita a organização e localização das informações.
  3. O nome das sub-pastas e páginas deve obedecer o padrão de nomenclatura corporativo.
  4. Utilize tags adequadas para ajudar na localização dos assuntos.
  5. Os modelos de documentação podem estar diferentes, pois muitas documentações são antigas. Neste caso, não há necessidade de refazer a documentação para adequar o modelo.
  6. Revisite as documentações, pelo menos, as mais importantes e mais acessadas pelos clientes. Avalie se o conteúdo está correto. Caso seja necessário atualizá-lo, então recomenda-se refazer a documentação no novo modelo.
  7. Atenção especial para os links internos que fazem referência a documentações que não existem mais.

Conclusão

(seleção) As páginas do período entre 2012 e 2016 devem ser verificadas e, mantidas, apenas as páginas válidas.

(seleção) As páginas posteriores a 2016 não precisam ser verificadas, neste momento.

(seleção) Todas as páginas válidas devem ser movidas para a pasta do Documento de Referência do módulo.

Mais informações