Ferramenta de documentação por IA para documentação interna e externa

A maioria das equipas documenta o mesmo fluxo de trabalho duas vezes. A versão interna é escrita para a equipa, a versão para o cliente é escrita separadamente por outra pessoa e, aos poucos, as duas deixam de descrever a mesma coisa.

Trupeer é uma ferramenta de documentação com IA para documentação interna e externa que permite às equipas registar um fluxo de trabalho uma vez e criar versões para equipas internas e para clientes. As duas começam a partir da mesma captura, por isso cobrem os mesmos passos, apesar de serem lidas de forma diferente.

O que é uma ferramenta de documentação interna e externa?

Software que pega num único fluxo de trabalho gravado e ajuda-o a produzir documentação para dois públicos a partir dele, em vez de escrever cada versão do zero.

A fonte é uma gravação do processo que está a ser executado. A IA gera os passos e os screenshots a partir dessa captura, o que lhe dá um rascunho que já contém tudo o que as duas versões precisam. Depois, adapta-o: a versão interna mantém o detalhe técnico e o contexto da equipa, a versão externa é simplificada para linguagem dirigida ao cliente, removendo qualquer informação interna. As versões finais são publicadas em destinos diferentes, normalmente uma base de conhecimento interna e um centro de ajuda público. Trupeer usa gravações de ecrã como fonte, gerando documentação editável passo a passo que pode depois ser adaptada para uso interno ou para clientes.

Documentação interna vs. documentação externa

Descrevem o mesmo fluxo de trabalho para leitores que precisam de coisas muito diferentes.

Os passos são os mesmos. O enquadramento, o vocabulário e o nível de detalhe não são, e é por isso que escrever separadamente parece necessário e por isso as versões se vão afastando quando o faz.

Uma fonte, dois públicos

A alternativa para escrever duas vezes é começar as duas versões a partir da mesma captura. O fluxo de trabalho é gravado uma vez; os documentos interno e externo são duas apresentações desse mesmo conteúdo.

A fonte mantém-se a mesma; o contexto específico do público muda.

Isso reduz o risco de divergência da documentação na fonte: as duas versões começam a partir dos mesmos passos observados, em vez de partirem de duas descrições separadas do mesmo processo feitas por pessoas diferentes.

Como funciona a documentação interna e externa

Passo 1: Grave o fluxo de trabalho uma vez

Capture o processo no seu browser ou carregue uma gravação que já tenha. Uma única captura serve os dois públicos, por isso não há uma segunda sessão para agendar.

Passo 2: Gere a documentação a partir de uma única fonte

A IA transforma as ações gravadas em passos estruturados, levando-o de uma captura de fluxo de trabalho “crua” para um rascunho de documentação editável. A Trupeer gera esse rascunho com um screenshot para cada ação. Esse único rascunho é a fonte de onde as duas versões partem, contendo todos os passos de que cada público precisa.

Passo 3: Adapte e publique cada versão

O rascunho gerado mantém-se editável, por isso adapta-o para cada público: mantenha o detalhe técnico e as notas de escalonamento internamente, simplifique a redação externamente e desfocque ou substitua o que não deve sair do edifício. Publique a versão interna onde a sua equipa procura e a versão externa no centro de ajuda, ou exporte qualquer uma para PDF ou Word.

O que pode criar com a Trupeer

A mesma gravação adapta-se a cada uma destas:

• Procedimentos internos (SOPs): o fluxo de trabalho completo com nomes de sistemas, percursos de escalonamento e o contexto que a sua equipa já tem

• Artigos de ajuda para o cliente: os mesmos passos em linguagem dirigida ao cliente, com o detalhe interno removido e screenshots limpos

• Guias de demonstração do produto: um vídeo narrado a partir da mesma captura, como saída secundária em paralelo com as versões escritas

• Documentação de suporte: resolução de problemas interna com o percurso de escalonamento e o guia público de resolução sem ele

• Formação interna: materiais de capacitação para suporte e vendas a partir do mesmo fluxo de trabalho que os clientes vão seguir

• Guias de onboarding para clientes: o processo de configuração tal como o cliente o executa, a partir da captura que a sua equipa já fez

Porque usar a Trupeer para documentação interna e externa?

• Uma única gravação em vez de sessões separadas de documentação para cada público

• Screenshots gerados a partir do fluxo de trabalho real, em vez de serem capturados duas vezes à mão

• Saída editável, para que as alterações específicas de cada público aconteçam no rascunho em vez de exigir uma reescrita

• Documentação escrita e vídeo a partir da mesma captura, com o vídeo como saída secundária

Antes e depois

Antes: uma empresa SaaS lança um novo fluxo de trabalho de faturação. O produto escreve um SOP interno. O suporte escreve separadamente um artigo para o centro de ajuda. Duas pessoas documentam um único fluxo de trabalho e, mais tarde, as duas versões podem divergir.

Depois: uma única gravação de ecrã produz as duas versões. A versão interna leva o fluxo de trabalho técnico, o contexto da equipa e o detalhe de escalonamento. A versão externa leva instruções simplificadas para o cliente, com screenshots e redação segura para o cliente. Quando o ecrã de faturação muda, grave novamente o fluxo de trabalho afetado e atualize as duas versões a partir dele.

Onde isto se aplica

• Lançamentos de produto: uma passagem interna para suporte e vendas, e um artigo de ajuda ao cliente, a partir do mesmo guia de funcionalidades

• Documentação de suporte: resolução de problemas interna com percursos de escalonamento e um guia público de resolução sem eles

• Onboarding de software: formação interna para a equipa e onboarding do cliente para novas contas

• Alterações de processo: um SOP interno a descrever o que a equipa faz e um aviso externo a descrever o que muda para o cliente

• Documentação de funcionalidades: contexto de produto e engenharia internamente, instruções da tarefa externamente

O que muda entre as duas versões

• Terminologia: os nomes de sistemas e internos passam a ser as palavras que os clientes usam

• Conhecimento assumido: a versão externa não pode pressupor familiaridade com os seus ecrãs de administração ou com o modelo de dados

• Escalonamento e atalhos: os percursos apenas internos saem da versão para o cliente

• Screenshots: ferramentas internas, identificadores de conta e qualquer informação sensível ficam desfocados ou são substituídos

• Âmbito: a versão interna muitas vezes cobre casos-limite que a versão externa omite deliberadamente

• Destino: uma vai para a base de conhecimento interna, a outra para o centro de ajuda

Manter as duas versões alinhadas

O motivo pelo qual a documentação interna e externa diverge é que é mantida separadamente. Alguém atualiza o SOP interno após uma alteração e ninguém informa a pessoa que é responsável pelo artigo do centro de ajuda.

Trabalhar a partir de um único fluxo de trabalho gravado reduz essa diferença: quando o processo muda, volta a gravar a parte afetada e atualiza as duas versões a partir da mesma fonte, em vez de ter de lembrar-se de quais documentos a jusante dependem disso. Não é automático e alguém ainda tem de notar que o processo mudou.

O que isto não faz

Não decide o que os clientes devem e não devem ver, não reescreve a linguagem interna para linguagem dirigida ao cliente sem revisão e não mantém as duas versões sincronizadas por si só. O juízo sobre o que sai do edifício é de uma pessoa, todas as vezes.

Para verificar um rascunho gerado antes de publicar, veja AI documentation accuracy. Para documentar funcionalidades do produto especificamente, veja the AI product documentation tool.

Crie as duas versões a partir de uma única gravação

Crie documentação interna e para o cliente a partir da mesma gravação do fluxo de trabalho com a Trupeer. Experimente a Trupeer gratuitamente.