131 lines
3.8 KiB
Markdown
131 lines
3.8 KiB
Markdown
# 📁 Documentation Structure
|
|
|
|
**Purpose:** Clear organization of all project documentation
|
|
|
|
---
|
|
|
|
## 🗂️ **Directory Structure**
|
|
|
|
```
|
|
documentation/
|
|
│
|
|
├── README.md # Main documentation index
|
|
├── STRUCTURE.md # This file - structure overview
|
|
│
|
|
├── ui-team-requirements/ # 📋 For UI Development Team
|
|
│ ├── UI_TEAM_DATA_TESTID_REQUIREMENTS.md
|
|
│ ├── UI_TEAM_MANDATORY_RESET_DATA_TESTID.md
|
|
│ └── UI_TEAM_QUICK_REFERENCE.md
|
|
│
|
|
├── automation-status/ # 🤖 For Automation Team
|
|
│ ├── LOCATOR_UPDATE_SUMMARY.md
|
|
│ ├── MANDATORY_RESET_FLOW_STATUS.md
|
|
│ ├── PASSWORD_RESET_FIX_SUMMARY.md
|
|
│ └── PASSWORD_RESET_IMPROVEMENTS.md
|
|
│
|
|
├── debug-tools/ # 🔧 Debugging & Tools
|
|
│ └── WORLD_CLASS_DEBUG_APPROACH.md
|
|
│
|
|
├── verification-reports/ # ✅ Verification & Reports
|
|
│ └── FINAL_VERIFICATION_SUMMARY.md
|
|
│
|
|
└── quick-references/ # 📖 Quick References
|
|
└── QUICK_REFERENCE_MANDATORY_RESET.md
|
|
```
|
|
|
|
---
|
|
|
|
## 📋 **File Descriptions**
|
|
|
|
### **UI Team Requirements** (`ui-team-requirements/`)
|
|
|
|
| File | Purpose | Audience |
|
|
|------|---------|----------|
|
|
| `UI_TEAM_DATA_TESTID_REQUIREMENTS.md` | Complete data-testid requirements for Profile Editor | UI Team |
|
|
| `UI_TEAM_MANDATORY_RESET_DATA_TESTID.md` | Missing data-testid for Password Reset Modal | UI Team |
|
|
| `UI_TEAM_QUICK_REFERENCE.md` | Quick reference for data-testid patterns | UI Team |
|
|
|
|
### **Automation Status** (`automation-status/`)
|
|
|
|
| File | Purpose | Audience |
|
|
|------|---------|----------|
|
|
| `LOCATOR_UPDATE_SUMMARY.md` | Summary of locator migration (XPath → data-testid) | Automation Team |
|
|
| `MANDATORY_RESET_FLOW_STATUS.md` | Current status of password reset flow | Automation Team |
|
|
| `PASSWORD_RESET_FIX_SUMMARY.md` | Summary of password reset fixes | Automation Team |
|
|
| `PASSWORD_RESET_IMPROVEMENTS.md` | Detailed improvements to password reset logic | Automation Team |
|
|
|
|
### **Debug Tools** (`debug-tools/`)
|
|
|
|
| File | Purpose | Audience |
|
|
|------|---------|----------|
|
|
| `WORLD_CLASS_DEBUG_APPROACH.md` | Systematic debug approach and DOM Inspector guide | Both Teams |
|
|
|
|
### **Verification Reports** (`verification-reports/`)
|
|
|
|
| File | Purpose | Audience |
|
|
|------|---------|----------|
|
|
| `FINAL_VERIFICATION_SUMMARY.md` | Final verification summary and completion status | Both Teams |
|
|
|
|
### **Quick References** (`quick-references/`)
|
|
|
|
| File | Purpose | Audience |
|
|
|------|---------|----------|
|
|
| `QUICK_REFERENCE_MANDATORY_RESET.md` | Quick reference for Mandatory Password Reset | Both Teams |
|
|
|
|
---
|
|
|
|
## 🎯 **Quick Access**
|
|
|
|
### **For UI Team:**
|
|
```bash
|
|
cd documentation/ui-team-requirements/
|
|
```
|
|
|
|
### **For Automation Team:**
|
|
```bash
|
|
cd documentation/automation-status/
|
|
```
|
|
|
|
### **For Debugging:**
|
|
```bash
|
|
cd documentation/debug-tools/
|
|
```
|
|
|
|
---
|
|
|
|
## ✅ **Organization Principles**
|
|
|
|
1. **By Audience:** Files organized by who needs them
|
|
2. **By Purpose:** Clear categorization of content
|
|
3. **Clean Root:** No documentation files in project root
|
|
4. **Easy Navigation:** Clear folder structure
|
|
5. **Maintainable:** Easy to add new documents
|
|
|
|
---
|
|
|
|
## 📝 **Adding New Documentation**
|
|
|
|
When adding new documentation:
|
|
|
|
1. **Identify Audience:** UI Team or Automation Team?
|
|
2. **Identify Purpose:** Requirements, Status, Debug, Verification, or Reference?
|
|
3. **Place in Correct Folder:** Follow existing structure
|
|
4. **Update README.md:** Add entry to main index
|
|
5. **Update STRUCTURE.md:** Add entry to this file if needed
|
|
|
|
---
|
|
|
|
## 🔄 **Maintenance**
|
|
|
|
- Keep structure clean and organized
|
|
- Update README.md when adding new documents
|
|
- Follow naming conventions
|
|
- Remove outdated documents
|
|
|
|
---
|
|
|
|
**Last Updated:** 2025-01-20
|
|
**Status:** ✅ Organized and Clean
|
|
|
|
|