Histórico da Página
...
- 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
...
Este formato foca exclusivamente nos campos da API, sem mencionar sua relação com o produto.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | int | Sim | Identificador único do usuário |
name | string | Sim | Nome do usuário |
email | string | Sim | Endereço de e-mail do usuário |
created_at | string | Não | Data de criação do usuário (ISO 8601) |
✅ Vantagens:
✔ Mais objetiva e técnica – Evita informações desnecessárias para desenvolvedores que só precisam da API.
✔ Fácil manutenção – Não precisa ser alterada caso a interface do produto mude.
✔ Facilidade para integradores externos – Desenvolvedores que não usam o produto podem entender os dados sem precisar de contexto extra.
...
Aqui, a documentação explica como os campos da API interagem com o produto.
| Campo | Tipo | Obrigatório | Descrição | Onde aparece no produto (no nosso caso os campos do PDV) |
|---|---|---|---|---|
id | int | Sim | Identificador único do usuário | ID exibido na tela de detalhes do usuário |
name | string | Sim | Nome do usuário | Tabela: Nome - Campo - nome_usuario |
email | string | Sim | Endereço de e-mail do usuário | E-mail mostrado no perfil do usuário e nas notificações |
created_at | string | Não | Data de criação do usuário (ISO 8601) | Data de registro visível na aba "Histórico" do painel de administração |
✅ Vantagens:
✔ Maior clareza para usuários do produto – Ajuda a entender como os dados da API afetam a interface.
✔ Melhor suporte para equipes internas – Suporte técnico, gerentes de produto e QA podem relacionar os dados da API com o que veem no sistema.
✔ Facilita a integração com o front-end – Desenvolvedores que trabalham na interface do produto sabem exatamente onde cada campo é usado. (No nosso caso o banco de dados do PDV)
❌ Desvantagens:
✖ Pode ficar mais complexa e extensa – Mais informações significam mais detalhes para manter e atualizar.
✖ Maior chance de desatualização – Se o produto mudar, a documentação pode ficar obsoleta rapidamente.
✖ Menos útil para integradores externos – Quem não usa o produto pode achar irrelevante a relação dos campos com a interface.
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas