...

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.

...

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:

Documento de Referência

Protheus 12

Call Center - Protheus 12

Conceitos - Call Center - P12

Configurações - Call Center - P12

Controle de Dados Protegidos - Call Center - P12

Integrações - Call Center - P12

Menu do Módulo - Call Center - P12

Pontos de Entrada - Call Center - P12

Artigos - Call Center - P12  (ex. sub-pasta criada pela Squad, movida da Base de Conhecimento)

Cálculos - Call Center - P12  (ex. sub-pasta criada pela Squad, movida da Base de Conhecimento)

Legislações - Call Center - P12 (ex. sub-pasta criada pela Squad, movida da Base de Conhecimento)

FAQs - Call Center - P12 (ex. sub-pasta criada pela Squad, movida da Base de Conhecimento)

Image Added

Opção Mover

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

...

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

 As páginas do período entre 2012 e 2016 devem ser verificadas e, mantidas, apenas as páginas válidas.

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

 Todas as páginas válidas devem ser movidas para a pasta do Documento de Referência do módulo.

Mais informações

• Consulte a página da Documentação Protheus
• Conheça a Política da Qualidade da Documentação Protheus

...