Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Painel
titleDocumentação API
Expandir
titlePadrão de documentação

O padrão para a documentação das APIs utilizado é o OpenAPI v3.

Para agilizar a documentação temos a ferramenta da engenharia com interface gráfica no link:  OpenAPI-GUI v3

Outra ferramenta é a extensão OpenAPI do VSCode. Nela podemos escrever o arquivo yml e visualizar utilizando o Swagger UI.



Expandir
titleRepositório de API

Definição...

Exemplo:





Expandir
titleSolução de Problemas

Segue abaixo os links de acesso as documentações de FAQs de Produtos do BackOffice desenvolvidos em PO UI com público-alvo geral, ou seja, é destinado a Desenvolvedores, Suporte Técnico e também para Clientes:


FAQ - Dashboard BackOffice


FAQ - Portal Gestão de Vendas


FAQ - Acompanha Custos (OBS: No final da página)


Segue abaixo o link de acesso a documentação de uma FAQ destinada a equipe de Suporte Técnico para apoio ao atendimento de tickets de Clientes:


PO UI - Documento de apoio ao suporte




Painel
titlePróximo Tópico
Expandir
titleA definir...

Definição...

Exemplo:





...