Pular para o conteúdo principal

Backlog de Documentação - Revisão Manual

Visão Geral​

Este documento lista as páginas que precisam de revisão manual para complementar a documentação automática gerada. As informações aqui foram inferidas a partir do código-fonte do projeto vWeb.

Páginas Principais Criadas​

✅ Concluído​

  • docs/intro.md - Introdução
  • docs/arquitetura.md - Arquitetura
  • docs/instalacao.md - Instalação
  • docs/modulos/index.md - Visão geral dos módulos
  • docs/modulos/cadastros.md - Cadastros
  • docs/modulos/financeiro.md - Financeiro
  • docs/modulos/estoque.md - Estoque
  • docs/modulos/pedidos.md - Pedidos
  • docs/modulos/orcamentos.md - Orçamentos
  • docs/modulos/os.md - Ordem de Serviço
  • docs/modulos/pdv.md - PDV
  • docs/modulos/agenda.md - Agenda
  • docs/modulos/tarefas.md - Tarefas
  • docs/modulos/relatorios.md - Relatórios
  • docs/modulos/dashboard.md - Dashboard
  • docs/modulos/configuracoes.md - Configurações
  • docs/fluxos/index.md - Fluxos principais
  • docs/faq/index.md - FAQ e Troubleshooting
  • sidebars.js - Sidebar configurada

Páginas Pendentes - Revisão Necessária​

1. Módulo Fiscal (_Fiscal/)​

**Status:**Planejado/Não implementado Caminho:D:\sistemas\vWeb\_Fiscal\

O que verificar:

  • Quais arquivos existem em _Fiscal/
  • Se há estrutura de NF-e/NFS-e
  • Quaisquer dependências ou integrações

Pendente desde: O módulo fiscal está no roadmap do README.md como "Planejado para futuro desenvolvimento"

2. API REST - Detalhamento​

Arquivo base:D:\sistemas\vWeb\Class\api.class.php

O que documentar:

  • Endpoints disponíveis
  • Autenticação (header X-API-Key)
  • Parâmetros de cada endpoint
  • Exemplos de requisição/resposta

Referência: Classe Api em api.class.php

3. Webhooks​

Pasta:D:\sistemas\vWeb\webhook\

O que documentar:

  • Quais eventos disparam webhooks
  • Formato do payload
  • Como configurar
  • Endpoints de callback

Status: Em "constante evolução" conforme README.md

4. Classes Não Documentadas​

ClasseArquivoStatus
atualizacao.class.phpClass/atualizacao.class.phpNão analisada
logs.class.phpClass/logs.class.phpNão analisada
cc.class.phpClass/cc.class.phpMencionada parcialmente
parametros.class.phpClass/parametros.class.phpMencionada parcialmente
salarios.class.phpClass/salarios.class.phpMencionada parcialmente
producao.class.phpClass/producao.class.phpMencionada parcialmente
servicos.class.phpClass/servicos.class.phpNão analisada
pedcompras.class.phpClass/pedcompras.class.phpNão analisada
tabelas.class.phpClass/tabelas.class.phpNão analisada
util.class.phpClass/util.class.phpMencionada parcialmente
html.class.phpClass/html.class.phpNão analisada
sefaz.class.phpClass/sefaz.class.phpNão analisada

5. Tabelas do Banco de Dados​

Referência:_BD/tabelas_sistema.sql

O que documentar:

  • Schema completo das tabelas
  • Relacionamentos
  • Campos principais
  • Índices

Status: O sistema cria as tabelas automaticamente (DB.class.php:333)

6. Telas/Rotas de Ajuda​

Mapeamento de rotas para páginas de ajuda:

Rota/TelaArquivoDocs relacionada
Loginlogin.htmlintro.md
Menumenu.htmlmodulos/index.md
Cadastros Index_Cadastros/cadastros_index.phpmodulos/cadastros.md
Lancamentos Index_Lancamentos/lancamentos_index.phpfluxos/index.md
Pessoas Edita_Cadastros/pessoas_edita.phpmodulos/cadastros.md
Produtos Edita_Cadastros/produtos_edita.phpmodulos/estoque.md
Contapag Edita_Lancamentos/contapag_edita.phpmodulos/financeiro.md
Contarec Edita_Lancamentos/contarec_edita.phpmodulos/financeiro.md
Pedidos Edita_Lancamentos/pedidos_edita.phpmodulos/pedidos.md
PDV Edita_Lancamentos/pdv_edita.phpmodulos/pdv.md
OS Edita_Lancamentos/os_edita.phpmodulos/os.md

7. Integração com PHPMailer​

Pasta:D:\sistemas\vWeb\PHPMailer\

O que documentar:

  • Configurações SMTP
  • Envio de e-mails transactional
  • Templates de e-mail

Referência: mencioado em README.md

8. Integração com QR Code​

Pasta:D:\sistemas\vWeb\phpqrcode\

O que documentar:

  • Geração de QR Codes para produtos
  • Utilização em etiquetas
  • API da biblioteca

Referência: _Cadastros/impressao_etiquetas_qrcode.php

9. Docker/Deploy​

Arquivos:

  • dockerfile
  • docker/entrypoint.sh
  • docker/php-custom.ini

O que documentar:

  • Instruções de deploy com Docker
  • Variáveis de ambiente
  • Configuração de produção

10. Funcionalidades Não Implementadas​

Conforme README.md:

  • Ordem de Serviço (OS) - Em desenvolvimento
  • API REST - Planejada
  • NF-e / NFS-e - Planejada para futuro
  • Planos SaaS e Billing automático - Em evolução
  • Importação e exportação de dados (CSV/Excel) - Em desenvolvimento
  • Sistema de tickets / suporte interno - Em desenvolvimento

Tarefas de Revisão​

Alta Prioridade​

  • Revisar docs/arquitetura.md - Verificar precisão das informações
  • Completar documentação da API REST
  • Documentar webhooks
  • Documentar schema do banco de dados

Média Prioridade​

  • Adicionar mais detalhes aos módulos existentes
  • Criar documentação de classes não analisadas
  • Adicionar screenshots/telas (se disponíveis)
  • Documentar configuração de e-mail

Baixa Prioridade​

  • Documentar deploy com Docker
  • Adicionar exemplos de código
  • Criar tutorial de uso por módulo
  • Documentar funcionalidades não implementadas

Fontes de Referência​

  • Código fonte principal: D:\sistemas\vWeb\
  • README do projeto: D:\sistemas\vWeb\README.md
  • Manifest PWA: D:\sistemas\vWeb\manifest.json
  • Constantes (exemplo): privado/constantes/constantes.vf (criado automaticamente)

Este documento foi gerado automaticamente com base na análise do código-fonte e deve ser revisado manualmente para garantir precisão e completude.