DOCUMENTAÇÃO

Índice

• DOCUMENTAÇÃO
• Índice
• 1. Documentação do Software
  • 1.1. Introdução
  • 1.2. Visão Geral do Sistema
  • 1.3. Funcionalidades
  • 1.4. Requisitos do Sistema
  • 1.5. Segurança
  • 1.6. Manutenção e Suporte

1. Documentação do Software

1.1. Introdução

• 1.1.1. Propósito
  • O objetivo do software é fornecer uma plataforma online que permita o restaurante gerenciar seu cardápio, receber pedidos, e processar pagamentos, enquanto os clientes podem navegar pelo menu, fazer pedidos e acompanhar o status dos mesmos.
  • Benefícios incluem:
    • Para Restaurantes: Aumentar o alcance de vendas, melhorar a gestão de pedidos, e oferecer uma experiência de compra mais conveniente.
    • Para Clientes: Facilidade em acessar o menu, personalizar pedidos, pagar online, e acompanhar o status dos pedidos em tempo real.
• 1.1.2. Público-Alvo
  • Restaurantes: Donos e gerentes de restaurantes que desejam oferecer um serviço de vendas online.
  • Clientes Finais: Usuários que desejam comprar alimentos de restaurantes através da internet.

1.2. Visão Geral do Sistema

• 1.2.1. Arquitetura do Sistema
  • Front-end: Desenvolvido utilizando HTML5 para estrutura, CSS3 para estilização e design responsivo, e TypeScript para lógica de interações dos usuários.
  • Back-end: Desenvolvido utilizando TypeScript e responsável pela comunicação com APIs para processamento de pagamento e gestão de pedidos.
  • Banco de Dados: Gerenciamento das informações de pratos, pedidos, e clientes.
• 1.2.2. Tecnologias Utilizadas
  • Linguagens: HTML5, CSS3, TypeScript.
  • Ferramentas e Plataformas: Visual Studio Code para desenvolvimento, Git para controle de versão, e plataformas de deploy como Netlify ou Vercel.

1.3. Funcionalidades

• Seleção de Pratos
  • Navegação pelo menu: Interface que permite ao cliente visualizar os pratos disponíveis.
  • Filtros e categorias: Opções para refinar a busca por pratos com base em categorias, preços, etc.
• Compra e Pagamento
  • Adição de itens ao carrinho: Função para adicionar pratos selecionados ao carrinho de compras.
  • Opções de pagamento: Integração com métodos de pagamento como cartões de crédito/débito e carteiras digitais.
• Acompanhamento do Pedido
  • Status do pedido: Visualização em tempo real do status do pedido (em preparo, a caminho, entregue).

1.4. Requisitos do Sistema

• 1.4.1. Requisitos de Hardware
  • Servidores para hospedagem do site.
  • Computadores ou dispositivos móveis para acesso ao sistema por clientes e restaurantes.
• 1.4.2. Requisitos de Software
  • Navegadores compatíveis com HTML5, CSS3 e TypeScript.
  • Servidores web como Apache ou Nginx.
• 1.4.3. Requisitos de Rede
  • Conexão de internet estável para acesso ao site e para comunicação entre front-end e back-end.

1.5. Segurança

• 1.5.1. Proteção de Dados
  • Uso de HTTPS para garantir a segurança das transações de dados entre o cliente e o servidor.
  • Armazenamento seguro de dados sensíveis, como informações de pagamento.
  • Total comprometimento com a segurança dos dados do software com base na LGPD.

1.6. Manutenção e Suporte

• 1.6.1. Atualizações do Software
  • Atualizações regulares para correção de bugs, melhorias de segurança e introdução de novas funcionalidades.
• 1.6.2. Suporte Técnico
  • Contato para suporte técnico disponível em horários específicos, com canais de comunicação como e-mail ou chat online.