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.

Solução 1 - Separando a documentação do PDVSync

• ✅ Vantagens:
  
  • ✔ Liberdade para estruturação da documentação - Sem depender de como a documentação do PDV esta disposta.
  • ✔ Maior visibilidade para desenvolvedores externos – Facilita o acesso para parceiros, startups e integradores.
  • ✔ Facilidade de versionamento – É mais fácil gerenciar e documentar versões diferentes da API sem interferir no produto.
• ❌ Desvantagens:
  • ✖ Pode gerar desconexão do produto – Se não houver sincronização eficiente, a documentação pode ficar desatualizada em relação ao produto.
  • ✖ Exige manutenção separada – A equipe pode precisar de um esforço adicional para manter a documentação alinhada com as mudanças do produto.
  • ✖ Estrutura pré-definida com base na documentação do PDV - Uma documentação pensada no negócio em si ao invés de API

Solução 2 - Unificando a documentação do PDVSync

• ✅ Vantagens:
  
  • ✔ Experiência unificada – Usuários do produto encontram a documentação no mesmo local, sem precisar buscar em fontes externas.
  • ✔ Maior alinhamento com a evolução do produto – Mudanças na API acompanham "automaticamente" as mudanças no produto.
  • ✔ Facilidade de acesso para clientes – Se a API for utilizada por clientes do próprio produto, o acesso integrado simplifica a adoção.
  • ✔ Melhor suporte e integração – Pode estar conectada a fóruns, FAQs e suporte técnico dentro do mesmo ecossistema.
• ❌ Desvantagens:
  • ✖ Pode dificultar a adoção por terceiros – Se a API for aberta, desenvolvedores externos podem ter dificuldade em encontrá-la.
  • ✖ Menos flexibilidade na organização da documentação – Pode ser difícil criar uma documentação modular e expansível dentro da estrutura do produto.
  • ✖ Risco de desatualização – Caso o foco esteja no produto principal, a documentação da API pode ficar desatualizada.