Ir para o conteúdo principal

Modelo de Documentação de Versões do Sistema [Premium]

Ao

lançar
uma
nova
versão
de
software,
a
documentação
é
1. tão crucial quanto o próprio código. Ela garante que usuários e desenvolvedores entendam as mudanças, novas funcionalidades, correçInformações Gerais da Versão:
e
como
interagir
    com o que foi atualizado.

    Aqui estão exemplos de como você pode documentar uma nova versão de software, focando em diferentes tipos de documentos e seus propósitos:

    1. Notas de Lançamento (Release Notes)

    As notas de lançamento são um dos documentos mais importantes para uma nova versão. Elas devem ser concisas, claras e facilmente acessíveis.

    Exemplo:

  • Produto: illiillimitar

  • Versão: 3.17.4.42

  • Pacote de Licença: Premium ou standard

  • Data de Lançamento: 24 de julho de 2025



3. Novidades nesta Versão (Highlights)Highlights - Se aplicável):

  • InterfaceNenhuma denova Usuáriofuncionalidade Renovada:destacada Experimentenesta umversão, designpois moderno e intuitivo, otimizado para melhor navegabilidade.

  • Integração comfoco Calendárioforam (Beta): Conecte-se diretamente com Google Calendar e Outlook para agendamento de tarefas.

  • Relatórios Personalizados: Crie e salve relatórios financeiros com filtros avançados.correções.



4. Melhorias e Novas Funcionalidades:

  • AdicionadaSem funcionalidademelhorias deregistradas arrastarnesta eversão. soltarApenas paracorreções organização de arquivos.aplicadas.


5. Correções de Bugs:
  • OtimizaçãoMódulo de performanceProdutos: paraCorrigido carregamentoo erro ao selecionar um grupo de grandesproduto conjuntosna deárvore dadoslateral (redução de 30% no tempo)ILLI-3152).

  • SuportePDV a autenticação(Ponto de doisVenda): fatoresRestaurado o comportamento esperado ao sair do caixa, que agora retorna corretamente à tela de login (2FA) para maior segurança.ILLI-3161).

  • Nova APIControle de WebhooksAcesso: paraA eventos de criação e atualizaçfunção de registros.

    ocultar
  • custo
via

Correçõesgrupo de Bugs:

usuário
    foi
  • revista

    Resolvidoe problemaagora ondeaplica filtrosas de pesquisa não eram aplicadosrestrições corretamente em dispositivostodos osveis.dulos, como Formação de Preço, Curva ABC e Ajustes de Estoque (ILLI-3167).

  • CorrigidoForma errode Pagamento:

    • Permitido deixar o campo "parceiro" em branco na associação de conta, permitindo que impediao sistema utilize o uploadcliente deda arquivosvenda PDF com caracteres especiais.(ILLI-3169).

    • AjustadoAjustada buga visualnatureza emda tarifa, que íconesagora seé sobrepunhamcorretamente emconsiderada telasmesmo quando aplicada via condição de baixapagamento, resoluçe não diretamente na forma de pagamento (ILLI-3175). Isso garante que os valores financeiros lançados e suas naturezas estejam alinhados com a configuração.o vigente.


  • Regras Fiscais: O campo "ICMS Origem" foi reinserido no cadastro de operação para atender fluxos fiscais mais flexíveis, mantendo a prioridade da configuração no produto e melhorando a visibilidade no cadastro (ILLI-3174).

  • Fluxo Financeiro: Ao cancelar uma venda no PDV, os títulos financeiros gerados com baixa automática agora são corretamente estornados, evitando inconsistências no financeiro (ILLI-3185).


6. Mudanças Importantes (Breaking Changes - para APIs ou desenvolvedores)Desenvolvedores - Se aplicável):

  • ONão endpoint /api/v2/usersmudanças foi descontinuado. Por favor, utilize /api/v3/usersimportantes que agoraquebrem requera autenticaçcompatibilidade ou exijam atenção porespecial tokende OAuth2.desenvolvedores nesta versão.


7. Problemas Conhecidos (Se aplicável):
  • Não há problemas conhecidos registrados para esta versão.


8. Tarefas Relacionadas à Versão (IDs de Tarefas/Tickets):
  • ILLI-3152 - Erro ao selecionar grupo produto

  • AILLI-3161 funç- Sair do caixa não está funcionando

  • ILLI-3167 - Oculta custo no grupo de usuário não aplica corretamente

  • ILLI-3169 - Associar parceiro a conta na forma de pagamento: permitir campo em branco

  • ILLI-3174 - ICMS Origem exclusivo no produto e operação

  • ILLI-3175 - Natureza da tarifa não é considerada na condição calculateTax()de agorapagamento

    retorna
  • um
  • objeto

    ILLI-3185 JSON- emPDV: vezestorno não cancela título de umbaixa valor numérico direto.automática



Problemas9. Conhecidos:Informações de Auditoria da Documentação:

  • ARevisão integraç#: [contagem de revisões]

  • Criado por: [duração comde otempo calendáriopor podeusuário]

    apresentar
  • lentidão
  • em

    Atualizado redespor: com baixa conectividade. Uma correç[duração estáde previstatempo parapor a versão 3.0.1.usuário]