Administração > Criando a documentação interna > Conceitos > Visão geral da documentação interna

Visão geral da documentação interna

O recurso Documentação Interna permite a adição de uma documentação personalizada (texto ou URL) à ajuda online existente.

Os usuários acessam essa documentação clicando no botão de ajuda, na área relevante do produto. É exibido um link para uma página que mostra a sua documentação na Ajuda do produto, com o título Documentação Interna.

É possível criar a documentação interna no painel Documentação Interna do módulo Administrador. Para obter detalhes, consulte Painel Documentação Interna.

Exemplo:

John é um administrador do Release Control na organização ABC. Sue, a administradora da Web, informa a John que ela pretende realizar a manutenção do site da empresa todas as segundas-feiras e pede a John que ele crie uma categoria de período de tempo no Release Control que impeça qualquer pessoa de fazer mudanças nesse site às segundas-feiras.

John cria uma categoria de período de tempo denominada Web_blecaute. Quando os usuários do Release Control entram, no Módulo Análise, na guia Avaliar > Conflitos de Período de Tempo, eles podem descobrir que sua mudança programada está em conflito com esse período de tempo Web_blecaute. John deseja uma maneira de explicar aos usuários por que essa categoria de tempo existe e decide escrever uma documentação interna.

Ele entra no painel Documentação Interna, (Módulo > Administrador > guia Configuração > Documentação Interna), seleciona Conflitos de Período de Tempo no painel Área do Produto e envia a documentação preenchendo os campos necessários e salvando suas mudanças:

Quando os usuários entram na guia Avaliar > Conflitos de Período de Tempo no módulo Análise e clicam no botão Ajuda , na ajuda do produto, é exibido um link para a documentação de John explicando o novo período de tempo.

Quando os usuários clicam no link, ele é aberto em uma página separada, exibindo o conteúdo enviado por John. John também poderia ter optado por documentar o período de tempo no site interno da empresa e, em vez de enviar o texto no painel Documentação Interna, poderia ter inserido uma URL. Nesse caso, o link abriria a URL diretamente.