Histórico da Página

...

• 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.
• Modelo 1 →
• 
  • ✔ Nessa documentação estamos conseguimos separar os envios conforme os micros serviços
  • ✔ Demonstrar estrutura do PDVSync e seu funcionamento
  • ✔ Processos
    • Descida de dados
    • Subida de dados
    • Processo Online
    • Consultas específicas LojaLoteRetorno (GET)
    • Integração de nova Loja
    • Entre outros
  • ✔ Troubleshooting
  • ✔ Instalação do Sync

Pontos de Melhoria

• Necessidade de atrelar essa doc na documentação do PDV para ter de referência
• Melhorar algumas informações em ordem de prioridade
  • Precisamos realmente de tantas abas na interface principal do produto?
  • Dificuldade de instruir o usuario com tantas informações logo de cara
    • Baixa
    • Envio
    • Online
• Ajustes no modelo da doc das API's
  • Adicionar campos do PDV?
  • Adicionar as informações referentes a v3 de forma clara
  • centralizar todos os tipos de Dados existentes em apenas um lugar
  • Melhor descrição das API's, para que serve e a sua relação entre elas
    • Exemplo: ProcessoOnline com fluxos dependentes que não são claros NotaEntrada + NotaSaida

1️⃣

...

Modelo da Doc da API 1: Apenas os dados da API

Este formato foca exclusivamente nos campos da API, sem mencionar sua relação com o produto.

...