Doniunique documentation init

Creating the first documentation of doniunique project
This commit is contained in:
reza 2024-12-08 20:32:52 +01:00
commit d291e8f905

114
Readme.md Normal file
View File

@ -0,0 +1,114 @@
# 📦 Product Coding Structure Documentation
Dear Team,
To organize our inventory efficiently, weve introduced a structured **Product Code System**. This documentation will guide you on how to create product codes accurately and consistently.
---
## 🔢 **Product Code Structure**
Each product code follows this format:
`[Category]-[Type]-[Material]-[Color]-[Size]-[Number]`
---
## 🗂 **Categories and Codes**
### 🏠 Home Decor (HDC)
| **Type** | **Type Code** |
|-------------------|---------------|
| Statue | STA |
| Candle | CND |
| Candle Holder | CHD |
| Table Vase | TVS |
| Planting Pot | POT |
| Wall Clock | WCL |
| Desk Clock | DCL |
---
### 👜 Leather Goods (LTH)
| **Type** | **Type Code** |
|-------------------|---------------|
| Keychain | KCH |
| Belt | BLT |
| Men's Bag | MBG |
| Women's Bag | WBG |
| Student Bag | SBG |
---
### 💎 Jewelry (JW)
| **Type** | **Type Code** |
|-------------------|---------------|
| Bracelet | BRC |
| Necklace | NCK |
| Ring | RNG |
---
## 🛠 **Material Short Codes**
| **Material** | **Code** |
|--------------|----------|
| Resin | RSN |
| Wood | WOD |
| Stone | STN |
| Leather | LTH |
| Metal | MTL |
---
## 🎨 **Color Short Codes**
| **Color** | **Code** |
|-----------|----------|
| Black | BLK |
| White | WHT |
| Brown | BRN |
| Gold | GLD |
| Red | RED |
| Blue | BLU |
| Green | GRN |
| Antique | ANT |
| Bronze | BRZ |
---
## 📝 **Examples**
1. **A bronze candle holder in resin, medium size**
`HDC-CHD-RSN-BRZ-M-008`
2. **An antique wooden wall clock**
`HDC-WCL-WOD-ANT-STD-009`
3. **A golden leather keychain**
`LTH-KCH-LTH-GLD-STD-010`
4. **A silver resin ring**
`JW-RNG-RSN-SLV-STD-011`
5. **A large bronze men's bag**
`LTH-MBG-LTH-BRZ-L-012`
---
## 🚨 **Important Notes**
1. **Consistency is key:**
Use the existing categories, types, materials, and colors as listed above.
2. **Discuss new additions:**
If a new material, type, or color is required, please discuss it with me before implementation to ensure uniformity.
3. **Unique Numbers:**
Ensure the last segment (number) of the code is unique for every product.
4. **Follow the format exactly:**
Adhering to the code structure is crucial for maintaining organization.
---
💡 **Have Questions or Suggestions?**
Feel free to reach out if you have any questions or ideas for improvement. Your contributions to keeping this system organized are greatly appreciated! 😊
**Thank you for your attention and support!**