documentação do sistema
This commit is contained in:
45
.context/docs/glossary.md
Normal file
45
.context/docs/glossary.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
type: doc
|
||||
name: glossary
|
||||
description: Project terminology, type definitions, domain entities, and business rules
|
||||
category: glossary
|
||||
generated: 2026-04-29
|
||||
status: active
|
||||
scaffoldVersion: "2.0.0"
|
||||
---
|
||||
|
||||
# Glossary & Domain Concepts
|
||||
|
||||
## Glossary
|
||||
- **PreOrder (Pré-venda)**: An order created by a seller that has not yet been billed.
|
||||
- **Cart (Carrinho)**: A temporary collection of products a customer intends to purchase.
|
||||
- **Checkout**: The process of finalizing an order, choosing payment methods and installments.
|
||||
- **Seller (Vendedor)**: The user using the application to sell products to customers.
|
||||
- **Partner (Parceiro)**: A B2B entity that works with the company, has specific commission and range logic.
|
||||
- **Tintométrico**: A specific feature related to color mixing, usually for paint products.
|
||||
|
||||
## Type Definitions
|
||||
- `Customer` (src/app/models/customer.model.ts)
|
||||
- `Product` (src/app/models/product.model.ts)
|
||||
- `Order` (src/app/models/order.model.ts)
|
||||
- `PreOrder` (src/app/models/pre-order.model.ts)
|
||||
- `CartModel` (src/app/models/cart.model.ts)
|
||||
- `SaleProduct` (src/app/models/sale-product.model.ts)
|
||||
|
||||
## Enumerations
|
||||
- `ShoppingActionTypes` (src/app/sales/store/actions/shopping.action.ts)
|
||||
- `CustomerSaleActionTypes` (src/app/sales/store/actions/customer-sale.action.ts)
|
||||
|
||||
## Core Terms
|
||||
- **State/Store**: Refers to the application's global Redux state (NgRx) which holds the current customer, cart contents, and authentication status.
|
||||
- **CRM**: Customer Relationship Management section where sellers can view, create, or edit customer profiles.
|
||||
|
||||
## Personas / Actors
|
||||
- **Seller (Vendedor)**: Wants to quickly look up products, add them to a cart, apply discounts, and checkout on behalf of a customer.
|
||||
- **Admin**: Configures permissions, views high-level dashboard KPIs.
|
||||
- **Partner (Parceiro)**: Checks commissions, extracts, and ranges.
|
||||
|
||||
## Domain Rules & Invariants
|
||||
- A cart must be associated with a customer before checkout.
|
||||
- Discounts are governed by specific authorization roles.
|
||||
- The `Tintométrico` module calculates specific prices based on color compositions.
|
||||
Reference in New Issue
Block a user