Changelog ou base de conhecimento: o que publicar quando seu SaaS muda
A novidade parece útil. Então o cliente tenta usar. Um exemplo de exportação CSV mostra como anúncio e artigo de ajuda podem acompanhar esse caminho.
Imagine abrir uma novidade do seu sistema de relatórios e descobrir que finalmente dá para agendar aquela exportação de toda segunda-feira. Você clica para configurar e encontra o mesmo anúncio: o benefício, uma imagem e nenhuma explicação sobre os filtros que o arquivo vai usar.
A equipe comunicou a entrega. Você ainda não consegue concluir a tarefa.
É nesse intervalo que o changelog e a base de conhecimento precisam se encontrar. A novidade ajuda a perceber uma mudança útil; o artigo de ajuda acompanha a pessoa durante o uso. Preparar os dois a partir do mesmo resumo faz sentido. Copiar o mesmo texto para os dois lugares costuma deixar uma dessas necessidades sem resposta.
Changelog e base de conhecimento atendem momentos diferentes
Quem abre o changelog quer se atualizar. A pessoa precisa entender se a mudança afeta seu trabalho, se está disponível para sua conta e onde pode experimentá-la. Uma boa novidade responde a essas perguntas em poucos parágrafos.
Quem abre um artigo de ajuda geralmente tem uma tarefa para concluir. Precisa de pré-requisitos, passos, resultado esperado e orientação quando algo dá errado. Pode chegar meses depois do lançamento, sem saber quando aquela funcionalidade apareceu.
Toda entrega precisa de dois textos?
Uma correção que não exige nenhuma ação pode precisar apenas de um anúncio curto. Uma nova configuração merece instruções. Quando um fluxo existente muda, revisar o guia atual costuma ajudar mais do que criar outro artigo que dispute espaço com ele.
A disponibilidade precisa aparecer nos dois materiais. Se apenas administradores têm acesso, avise antes de a pessoa dedicar tempo à configuração. Se a liberação é gradual, explique quem já pode usar. São escolhas pequenas de escrita que podem poupar uma busca frustrada pelas configurações.
As próprias ferramentas estão aproximando essas áreas: a AnnounceKit anunciou uma base de conhecimento em beta junto ao changelog em agosto de 2026. Reunir os conteúdos facilita a descoberta. Cada texto ainda precisa atender ao motivo que trouxe o leitor até ele.
Exemplo prático: exportação semanal em CSV
O exemplo a seguir descreve um SaaS fictício de relatórios. A funcionalidade, as telas e o comportamento são ilustrativos; não são recursos do Sinalio.
Imagine uma equipe de operações que exporta relatórios toda segunda-feira. O resumo validado da entrega informa que administradores de relatórios podem agendar um CSV semanal a partir de um relatório salvo. O agendamento guarda os filtros selecionados, usa o fuso horário do workspace e disponibiliza o arquivo no histórico de exportações.
Há uma condição importante: alterar o relatório salvo depois não modifica um agendamento existente. O anúncio apresenta o benefício; a documentação precisa explicar esse comportamento para evitar dúvidas no próximo fechamento semanal.
Exemplo de novidade para o changelog
Deixe a exportação semanal do seu relatório agendada
Administradores de relatórios agora podem agendar uma exportação semanal em CSV. Escolha o dia e o horário uma vez e encontre cada arquivo concluído no histórico de exportações.
Para começar, abra Relatórios → Exportações e selecione Novo agendamento. O processo usa o fuso horário do workspace e mantém os filtros escolhidos na criação.
Consulte o guia de configuração para ver os passos, alterar filtros e resolver dúvidas.
A novidade explica a utilidade e oferece um próximo passo. Os detalhes de configuração ficam no guia, onde o cliente pode consultá-los durante a tarefa.
Transforme o mesmo resumo em um artigo de ajuda
Exemplo de artigo de ajuda
Antes de começar
Você precisa de acesso de administrador de relatórios e de um relatório salvo. Confira o fuso horário do workspace e os filtros que deseja reutilizar.
Crie o agendamento
- Abra Relatórios → Exportações e selecione Novo agendamento.
- Escolha o relatório salvo.
- Selecione Semanal e defina o dia e o horário.
- Revise os filtros e o fuso horário do workspace.
- Selecione Salvar agendamento.
Resultado esperado: o agendamento aparece na lista com a próxima execução. Depois de uma execução bem-sucedida, o CSV fica disponível no histórico de exportações.
Para mudar os filtros: edite o agendamento. Alterar apenas o relatório salvo não atualiza os filtros de um agendamento existente.
Se o próximo horário parecer incorreto: confira o fuso horário do workspace, o dia e o horário selecionados antes de salvar novamente.
Na documentação de um produto real, execute os passos na interface antes de publicar. Inclua capturas de tela quando elas ajudarem a explicar uma escolha, sem expor dados de clientes.
Claude ou ChatGPT podem ajudar a transformar um resumo validado nesses dois rascunhos, especialmente quando há várias restrições a preservar. Informe os nomes reais das telas e o comportamento confirmado; peça que a ferramenta aponte o que falta. Depois, compare o texto com o produto. Uma frase bem escrita sobre uma configuração inexistente continua sendo uma instrução que não funciona. Nosso artigo anterior sobre o fluxo com IA, em inglês desenvolve essa parte da preparação.
A novidade fica no histórico; as instruções acompanham o produto
Um mês depois, imagine que o produto fictício passe a permitir que os agendamentos acompanhem as alterações no relatório salvo. O artigo de ajuda precisa explicar o novo comportamento. Quem dependia da regra anterior também precisa saber o que mudou.
O anúncio original pode continuar como registro do lançamento. Acrescente uma observação datada se alguém que chegar até ele hoje puder entender algo errado, com um link para as instruções atuais. Reescrever todas as novidades antigas como se o produto sempre tivesse funcionado daquele jeito tornaria o histórico difícil de acompanhar.
Por isso, a ligação entre os materiais importa. Quem chega pela página pública de novidades deve encontrar o guia atual. Quem segue o guia não deveria precisar ler uma sequência de lançamentos antigos para descobrir como o sistema funciona agora.
Antes de publicar, peça a alguém que não participou da implementação para seguir as instruções. Observe onde a pessoa hesita. Essa pausa pode revelar mais do que outra rodada de revisão de texto.
No exemplo do CSV, o resultado esperado é simples: na próxima segunda-feira, o cliente sabe onde encontrar o arquivo, quais filtros ele contém e o que precisa ajustar antes da execução seguinte. A novidade chamou sua atenção. O guia ajudou a retomar o trabalho.
