Document toolboxDocument toolbox

Como criar o histórico de um documento

Objetivo

Quando o produto sofre alguma alteração e essas informações devem ser adicionadas, removidas ou alteradas na documentação, há a possibilidade de utilizar o versionamento, a depender da necessidade do produto.

Ele serve para criarmos o histórico da documentação, possibilitando sempre que o usuário tenha acesso a funcionalidades que estavam disponíveis em versões anteriores.

Uma nova versão só poderá ser criada quando a versão Current estiver criada.

Instruções

Passo 1 - Criar a nova versão

  1. Acesse o espaço no Confluence 

  2. Na barra lateral esquerda, clique em Scroll Documents 

  3. Localize o documento desejado e clique nele

  4. Clique no botão Save a version no canto superior direito

  5. Na aba Basic, insira as seguintes informações:

    1. Version: preencha com a versão atual do produto

    2. Description: deixe em branco ou insira informações pertinentes à versão

    3. Status: selecione APPROVED

    4. Restrictions: selecione No restrictions

  6. Na aba Advanced, insira as seguintes informações:

    1. Based on version: selecione a Current e o idioma Portuguese

    2. Prefix: não altere o prefixo, pois ele herdou o valor da versão que você digitou na aba Basic

    3. Content: marque a opção Resolve include page macros para que a nova versão herde as macros das páginas da versão Current

  7. Clique no botão Save

Se a documentação do seu produto for disponibilizada apenas em português, não realize o Passo 2 - Herdar os idiomas da versão Current.

Entretanto, se for disponibilizada em mais idiomas, é necessária a realização do Passo 2 - Herdar os idiomas da versão Current.

Passo 2 - Herdar os idiomas da versão Current

Para que a nova versão herde os idiomas da versão Current, é necessário realizar a adição das traduções (Tranlations).

  1. Na nova versão do documento, clique em Add translation

  2. Clique em Manual Translation

  3. Clique no botão Next

  4. Na aba Basic, insira as seguintes informações:

    1. Language: selecione o idioma que deseja herdar da versão Current

    2. Restrictions: selecione No restrictions

    3. Translation reuse: marque a opção Reuse translated content from version Current para reutilizar a tradução da versão Current

  5. Na aba Advanced, insira as seguintes informações:

    1. Prefix: não altere o prefixo

    2. Content: marque a opção Resolve include page macros para que a nova versão herde as macros das páginas da versão Current

  6. Clique no botão Next

  7. Na barra superior, clique na opção Select all para selecionar todas as páginas

  8. Clique em Save

Repita os passos até adicionar todos os idiomas desejados.

Após a adição das traduções à versão, altere o status conforme orientado aqui.

 

Se desejar, você pode publicar o histórico de versões no Help Center.

A publicação do histórico de versões no Help Center não é obrigatória e depende da necessidade do produto.