Objetivo

• Propor e definir um padrão de documentação para o PDVSync, considerando integração com o PDV, organização clara dos dados e alinhamento entre os times envolvidos.

Descrição

• Atualmente, a documentação do PDVSync apresenta problemas de fluidez e clareza, especialmente em relação às diferentes versões existentes e à integração com tabelas do PDV. Por vezes, dados relacionados a tabelas distintas do PDV são tratados na mesma API do Sync, o que resulta em descentralização de informações e dificuldade de uso.
• Essa spike tem como objetivo elaborar e avaliar novos modelos de documentação para todos fluxos do PDVSync:
  • APIs Online:
    • Fluxos de dados em tempo real entre o PDV e a retaguarda.
  • Baixa de Dados:
    • Processos de transferência de informações da retaguarda para o PDV.
  • Envio de Dados:
    • Processos de envio de informações do PDV para a retaguarda.
  • As etapas incluem:
    • Criação dos modelos
      • Desenvolver propostas claras e organizadas para documentar os três fluxos mencionados, integrando informações relacionadas às tabelas do PDV de forma centralizada.
    • Comparação com a documentação atual do Sync
      • Avaliar os modelos propostos em relação à documentação existente, identificando melhorias necessárias.
    • Alinhamento entre times
      • Compartilhar os modelos com os times PDV e Sync, promovendo uma discussão colaborativa para chegar a um consenso sobre o padrão mais eficiente.
    • Unificação ou independência
      • Decidir, em conjunto, se a documentação do Sync será unificada com a documentação do PDV ou seguirá um modelo independente.
• O objetivo final é entregar uma documentação que seja funcional, fluida e clara para todos os stakeholders.

Critérios de Aceite

• Modelos de documentação elaborados para os três fluxos principais:
  • APIs Online.
  • Baixa de Dados.
  • Envio de Dados.
• Comparação estruturada entre os novos modelos e a documentação atual do Sync, com registro das melhorias propostas.
• Reunião realizada com os times PDV e Sync, com feedback documentado e consenso sobre o melhor modelo.
• Definição clara sobre unificação ou independência da documentação do Sync em relação ao PDV.
• Entrega de um documento consolidado com o padrão aprovado e plano de implementação.