Disponibilizar as Informações de Atualização de Versão
Histórico de Alterações
| Data | Quem | Comentários |
|---|---|---|
| 11/09/2026 | Renato Lima | Criação do documento |
Necessidade
O cliente necessita de um local no sistema onde possa consultar as atualizações disponibilizadas nas versões do GeoSales, permitindo identificar, de forma simples e organizada, as melhorias, funcionalidades e alterações liberadas ao longo do tempo.
As informações deverão apresentar uma descrição funcional das atualizações relevantes para o usuário, possibilitando o acompanhamento das mudanças disponibilizadas em cada versão e a consulta de um histórico das atualizações por período.
Para atender a essa necessidade, é necessário disponibilizar um mecanismo de seleção das informações que serão exibidas, considerando que o changelog técnico existente também contempla alterações internas, ajustes operacionais e outras informações que não devem necessariamente ser apresentadas aos clientes.
Solução
Implementar uma funcionalidade para consulta do histórico de atualizações das versões do GeoSales, utilizando como referência o changelog existente e permitindo o cadastro manual das informações que deverão ser disponibilizadas aos clientes.
Durante o processo de preparação de uma nova versão, as atualizações relevantes deverão ser selecionadas e descritas em linguagem simples, com foco nos benefícios e comportamentos percebidos pelo usuário. Somente as informações definidas para divulgação serão apresentadas na consulta.
A solução deverá contemplar:
- Cadastro ou preenchimento de uma descrição específica para divulgação de cada atualização, associada à respectiva versão.
- Possibilidade de definir quais atualizações serão apresentadas aos clientes.
- Identificação da versão e da data de disponibilização das atualizações.
- Consulta do histórico de versões e respectivas alterações divulgadas.
- Organização das informações por versão, com possibilidade de filtrar o histórico por período.
- Exibição das informações em uma interface integrada à identificação da versão no sistema, preferencialmente aproveitando o popup existente, mediante expansão de sua estrutura.
As informações destinadas à divulgação deverão ser mantidas de forma independente do changelog técnico original, evitando que alterações internas sejam publicadas automaticamente.
Implementação
1. Adequação da estrutura de dados: criar ou adaptar os campos necessários para armazenar a descrição destinada à divulgação e a indicação de quais atualizações poderão ser apresentadas aos clientes, associando os registros à versão correspondente.
2. Preparação da versão: durante o processo de preparação e aprovação de uma versão, identificar as alterações relevantes para os clientes e registrar suas respectivas descrições em linguagem funcional.
3. Seleção das atualizações: permitir que o responsável pela preparação da versão determine quais informações serão disponibilizadas para consulta, mantendo as alterações não selecionadas restritas ao histórico técnico.
4. Disponibilização das informações: após a aprovação e publicação da versão, apresentar as atualizações selecionadas na área de consulta do sistema.
5. Interface de consulta: adaptar o popup existente, se tecnicamente viável, para permitir a visualização das atualizações por versão, com identificação da data, descrição das alterações e acesso ao histórico.
6.Filtro do histórico: disponibilizar um filtro por período para facilitar a consulta das atualizações publicadas em determinado intervalo de tempo.
7. Validação: realizar os testes em ambiente de homologação, verificando o cadastro, a seleção, a publicação e a consulta das informações antes da disponibilização em produção.
Escopo
Escopo Incluso
Criação ou adequação da estrutura de armazenamento das informações de atualização destinadas aos clientes.
Associação das informações à respectiva versão do sistema.
Cadastro manual das descrições funcionais das atualizações.
Identificação das atualizações que deverão ser exibidas aos clientes.
Restrição da consulta às informações selecionadas para divulgação.
Exibição da identificação da versão, da data e das respectivas descrições.
Consulta do histórico de atualizações disponibilizadas.
Implementação de filtro por período.
Adequação do popup existente para apresentação das informações, conforme viabilidade técnica.
Testes funcionais em homologação.
Escopo Não Incluso
Criação ou adequação da estrutura de armazenamento das informações de atualização destinadas aos clientes.
Associação das informações à respectiva versão do sistema.
Cadastro manual das descrições funcionais das atualizações.
Identificação das atualizações que deverão ser exibidas aos clientes.
Restrição da consulta às informações selecionadas para divulgação.
Exibição da identificação da versão, da data e das respectivas descrições.
Consulta do histórico de atualizações disponibilizadas.
Implementação de filtro por período.
Adequação do popup existente para apresentação das informações, conforme viabilidade técnica.
Testes funcionais em homologação.
Escopo Não Incluso
Publicação automática e integral do changelog técnico existente.
Exibição automática de todas as alterações registradas durante o desenvolvimento.
Divulgação de ajustes internos, correções técnicas ou alterações operacionais não selecionadas para publicação.
Geração automática de textos explicativos a partir das descrições técnicas do changelog.
Envio de notificações, e-mails ou mensagens aos clientes informando sobre novas versões.
Implementação de um portal externo ou de uma página pública para consulta das versões.
Alteração do processo de versionamento, compilação ou publicação do sistema.
Migração automática de todo o histórico de versões anteriores, salvo se definida posteriormente como necessidade complementar.
Atores
Responsável pela preparação da versão: identifica as alterações relevantes, registra as descrições funcionais e seleciona as informações destinadas à divulgação.
Equipe de desenvolvimento: implementa a estrutura de armazenamento, os mecanismos de seleção e a interface de consulta das atualizações.
Equipe de testes/homologação: valida o comportamento da funcionalidade e verifica se somente as informações selecionadas são apresentadas.
Cliente/usuário do GeoSales: consulta o histórico de versões e as atualizações disponibilizadas no sistema.
Pré-condições
Deve existir uma versão do GeoSales identificada no processo de disponibilização.
O changelog técnico ou as informações referentes às alterações realizadas devem estar disponíveis para consulta pela equipe responsável.
O responsável pela preparação da versão deve ter acesso ao mecanismo de cadastro e seleção das informações destinadas à divulgação.
As descrições das atualizações devem estar registradas e associadas à respectiva versão antes de sua disponibilização aos clientes.
A funcionalidade de consulta deve estar habilitada no ambiente em que será utilizada.
Pós-condições
As atualizações selecionadas para divulgação ficam armazenadas e associadas à versão correspondente.
O usuário consegue consultar as informações disponibilizadas para cada versão.
O histórico de atualizações publicadas permanece disponível para consultas posteriores.
As alterações não selecionadas para divulgação não são apresentadas na consulta destinada aos clientes.
As informações permanecem organizadas por versão e podem ser consultadas conforme o período informado no filtro.
Regras de Negócio
RN01 — Associação à versão: toda atualização destinada à divulgação deverá estar vinculada à respectiva versão do GeoSales.
RN02 — Seleção para divulgação: somente as atualizações explicitamente selecionadas para divulgação poderão ser apresentadas na consulta destinada aos clientes.
RN03 — Descrição funcional: as atualizações selecionadas deverão possuir uma descrição em linguagem simples, permitindo ao usuário compreender o que foi alterado ou disponibilizado.
RN04 — Separação do changelog técnico: o changelog técnico original não deverá ser publicado integralmente de forma automática. As informações deverão passar por uma seleção e descrição específica antes de serem disponibilizadas.
RN05 — Identificação da versão: as informações apresentadas deverão permitir identificar claramente a versão à qual pertencem.
RN06 — Data de disponibilização: cada conjunto de atualizações deverá apresentar a data correspondente à disponibilização da versão, permitindo ao usuário identificar quando as alterações foram liberadas.
RN07 — Organização do histórico: as atualizações deverão ser agrupadas por versão, mantendo a identificação e as descrições das alterações relacionadas.
RN08 — Filtro por período: o usuário deverá conseguir consultar as atualizações considerando um intervalo de datas, facilitando a visualização das alterações disponibilizadas no período informado.
RN09 — Atualizações sem divulgação: alterações internas, técnicas ou operacionais que não tenham sido selecionadas não deverão ser exibidas na consulta dos clientes.
RN10 — Consulta de versões anteriores: as atualizações anteriormente disponibilizadas deverão permanecer acessíveis no histórico, conforme os critérios de consulta definidos para a funcionalidade.
RN11 — Disponibilização condicionada à publicação: as informações de uma versão somente deverão ficar disponíveis para consulta dos clientes após a efetiva disponibilização da respectiva versão.
RN12 — Manutenção das informações: deverá ser possível registrar as descrições destinadas à divulgação durante a preparação da versão, sem exigir a alteração do conteúdo técnico original do changelog.
Fluxograma
Fluxo resumido da solução
Aprovação
Considero aprovada a documentação da funcionalidade especificada acima, e autorizo a implementação da mesma no Sistema GeoSales, em nome da Organização a qual estou vinculado.
GeoSales
| Setor | Aprovado Por | Data |
|---|---|---|
| Integração - GeoSales | dd/mm/aaaa |
Empresa solicitante
| Setor | Aprovado Por | Data | Assinatura |
|---|---|---|---|
| Gerente TI - Cliente | Pessoa que aprovou | 00/00/0000 | |
| Gerente de Projeto - Cliente | Pessoa que aprovou | 00/00/0000 | |
| Gerente Comercial - Cliente | Pessoa que aprovou | 00/00/0000 |