217 lines
8.2 KiB
Markdown
217 lines
8.2 KiB
Markdown
# Helpdesk Rating Five Stars - Documentation Index
|
|
|
|
Welcome to the Helpdesk Rating Five Stars module documentation. This index will help you find the information you need.
|
|
|
|
## 📚 Documentation Files
|
|
|
|
### Quick Start
|
|
|
|
- **[README.md](README.md)** - Start here! Overview, features, and quick installation guide
|
|
- **[INSTALL.md](INSTALL.md)** - Detailed installation instructions for all environments
|
|
|
|
### User Documentation
|
|
|
|
- **[USER_GUIDE.md](USER_GUIDE.md)** - Complete guide for customers, agents, managers, and administrators
|
|
- **[static/description/index.html](static/description/index.html)** - Web-based module documentation (visible in Odoo Apps)
|
|
|
|
### Technical Documentation
|
|
|
|
- **[CHANGELOG.md](CHANGELOG.md)** - Version history and changes
|
|
- **[__manifest__.py](__manifest__.py)** - Module metadata and configuration
|
|
- **[hooks.py](hooks.py)** - Post-installation hooks and migration logic
|
|
|
|
### Additional Resources
|
|
|
|
- **[static/description/ICON_README.md](static/description/ICON_README.md)** - Instructions for creating the module icon
|
|
- **[static/src/README.md](static/src/README.md)** - Frontend assets documentation
|
|
- **[static/description/widget_demo.html](static/description/widget_demo.html)** - Interactive widget demonstration
|
|
|
|
## 🎯 Documentation by Role
|
|
|
|
### For Customers
|
|
|
|
**I want to rate a helpdesk ticket**
|
|
|
|
1. Read: [USER_GUIDE.md - For Customers](USER_GUIDE.md#for-customers)
|
|
2. Learn about: Rating via email, rating via web form, changing ratings
|
|
|
|
### For Helpdesk Agents
|
|
|
|
**I want to view and understand customer ratings**
|
|
|
|
1. Read: [USER_GUIDE.md - For Helpdesk Agents](USER_GUIDE.md#for-helpdesk-agents)
|
|
2. Learn about: Viewing ratings in different views, understanding rating values
|
|
|
|
### For Helpdesk Managers
|
|
|
|
**I want to analyze rating statistics and team performance**
|
|
|
|
1. Read: [USER_GUIDE.md - For Helpdesk Managers](USER_GUIDE.md#for-helpdesk-managers)
|
|
2. Learn about: Rating reports, filtering, exporting, performance goals
|
|
|
|
### For System Administrators
|
|
|
|
**I want to install, configure, and maintain the module**
|
|
|
|
1. Read: [INSTALL.md](INSTALL.md) - Installation instructions
|
|
2. Read: [USER_GUIDE.md - For System Administrators](USER_GUIDE.md#for-system-administrators)
|
|
3. Read: [README.md - Technical Details](README.md#technical-details)
|
|
|
|
### For Developers
|
|
|
|
**I want to understand the code and extend the module**
|
|
|
|
1. Read: [README.md - Development](README.md#development)
|
|
2. Review: Source code in `models/`, `controllers/`, `views/`
|
|
3. Check: Tests in `tests/` directory
|
|
4. See: [CHANGELOG.md](CHANGELOG.md) for version history
|
|
|
|
## 📖 Documentation by Topic
|
|
|
|
### Installation
|
|
|
|
- [INSTALL.md](INSTALL.md) - Complete installation guide
|
|
- [README.md - Installation](README.md#installation) - Quick installation steps
|
|
- [USER_GUIDE.md - Installation](USER_GUIDE.md#for-system-administrators) - Admin perspective
|
|
|
|
### Configuration
|
|
|
|
- [USER_GUIDE.md - Configuration](USER_GUIDE.md#for-system-administrators) - Configuration options
|
|
- [README.md - Configuration](README.md#configuration) - Technical configuration
|
|
- [__manifest__.py](__manifest__.py) - Module dependencies and settings
|
|
|
|
### Usage
|
|
|
|
- [USER_GUIDE.md](USER_GUIDE.md) - Complete usage guide for all roles
|
|
- [static/description/index.html](static/description/index.html) - Usage examples
|
|
- [static/description/widget_demo.html](static/description/widget_demo.html) - Interactive demo
|
|
|
|
### Features
|
|
|
|
- [README.md - Features](README.md#features) - Feature list
|
|
- [static/description/index.html](static/description/index.html) - Detailed feature descriptions
|
|
- [CHANGELOG.md](CHANGELOG.md) - Feature history
|
|
|
|
### Technical Details
|
|
|
|
- [README.md - Technical Details](README.md#technical-details) - Architecture and structure
|
|
- [hooks.py](hooks.py) - Migration logic
|
|
- Source code files with inline documentation
|
|
|
|
### Troubleshooting
|
|
|
|
- [INSTALL.md - Troubleshooting](INSTALL.md#troubleshooting-installation) - Installation issues
|
|
- [USER_GUIDE.md - FAQ](USER_GUIDE.md#frequently-asked-questions) - Common questions
|
|
- [USER_GUIDE.md - Troubleshooting](USER_GUIDE.md#for-system-administrators) - Admin troubleshooting
|
|
|
|
### Testing
|
|
|
|
- [README.md - Development](README.md#development) - Running tests
|
|
- [tests/](tests/) - Test files
|
|
- Test runner scripts in project root
|
|
|
|
### Security
|
|
|
|
- [README.md - Security](README.md#security) - Security measures
|
|
- [USER_GUIDE.md - Security](USER_GUIDE.md#for-system-administrators) - Security considerations
|
|
- [security/](security/) - Access control files
|
|
|
|
### API and Integration
|
|
|
|
- [README.md - API Compatibility](README.md#api-compatibility) - API details
|
|
- [README.md - Compatibility](README.md#compatibility) - Module compatibility
|
|
- Source code for API reference
|
|
|
|
## 🔍 Quick Reference
|
|
|
|
### Common Tasks
|
|
|
|
| Task | Documentation |
|
|
|------|---------------|
|
|
| Install the module | [INSTALL.md](INSTALL.md) |
|
|
| Rate a ticket (customer) | [USER_GUIDE.md - For Customers](USER_GUIDE.md#for-customers) |
|
|
| View ratings (agent) | [USER_GUIDE.md - For Helpdesk Agents](USER_GUIDE.md#for-helpdesk-agents) |
|
|
| Analyze ratings (manager) | [USER_GUIDE.md - For Helpdesk Managers](USER_GUIDE.md#for-helpdesk-managers) |
|
|
| Configure email templates | [USER_GUIDE.md - Configuration](USER_GUIDE.md#for-system-administrators) |
|
|
| Troubleshoot issues | [USER_GUIDE.md - FAQ](USER_GUIDE.md#frequently-asked-questions) |
|
|
| Run tests | [README.md - Development](README.md#development) |
|
|
| Customize the icon | [static/description/ICON_README.md](static/description/ICON_README.md) |
|
|
| Understand migration | [hooks.py](hooks.py) and [CHANGELOG.md](CHANGELOG.md) |
|
|
| Extend the module | [README.md - Development](README.md#development) |
|
|
|
|
### Key Concepts
|
|
|
|
| Concept | Where to Learn |
|
|
|---------|----------------|
|
|
| 5-star rating system | [README.md - Overview](README.md#overview) |
|
|
| Rating migration (0-3 to 0-5) | [USER_GUIDE.md - FAQ](USER_GUIDE.md#frequently-asked-questions) |
|
|
| Star rating widget | [static/description/widget_demo.html](static/description/widget_demo.html) |
|
|
| Email rating links | [USER_GUIDE.md - For Customers](USER_GUIDE.md#for-customers) |
|
|
| Backend star display | [USER_GUIDE.md - For Helpdesk Agents](USER_GUIDE.md#for-helpdesk-agents) |
|
|
| Rating reports | [USER_GUIDE.md - For Helpdesk Managers](USER_GUIDE.md#for-helpdesk-managers) |
|
|
| Token-based security | [README.md - Security](README.md#security) |
|
|
| Accessibility features | [README.md - Accessibility](README.md#accessibility) |
|
|
|
|
## 📋 Documentation Standards
|
|
|
|
All documentation in this module follows these standards:
|
|
|
|
- **Markdown Format**: Easy to read and version control
|
|
- **Clear Structure**: Organized with headers and sections
|
|
- **Examples**: Practical examples for common tasks
|
|
- **Code Blocks**: Syntax-highlighted code snippets
|
|
- **Tables**: Quick reference information
|
|
- **Links**: Cross-references between documents
|
|
- **Up-to-date**: Maintained with each version
|
|
|
|
## 🆘 Getting Help
|
|
|
|
If you can't find what you need in the documentation:
|
|
|
|
1. **Search**: Use Ctrl+F to search within documentation files
|
|
2. **FAQ**: Check [USER_GUIDE.md - FAQ](USER_GUIDE.md#frequently-asked-questions)
|
|
3. **Logs**: Review Odoo server logs for error messages
|
|
4. **Source Code**: Check inline code documentation
|
|
5. **Administrator**: Contact your Odoo system administrator
|
|
6. **Community**: Odoo community forums and resources
|
|
|
|
## 📝 Contributing to Documentation
|
|
|
|
To improve this documentation:
|
|
|
|
1. Identify gaps or unclear sections
|
|
2. Make improvements to relevant files
|
|
3. Follow existing documentation style
|
|
4. Update this index if adding new files
|
|
5. Test instructions before submitting
|
|
6. Submit changes to module maintainer
|
|
|
|
## 🔄 Documentation Updates
|
|
|
|
This documentation is maintained with each module version:
|
|
|
|
- **Version 1.0.0**: Initial documentation release
|
|
- See [CHANGELOG.md](CHANGELOG.md) for version history
|
|
|
|
## 📄 License
|
|
|
|
All documentation is provided under the same license as the module (LGPL-3).
|
|
|
|
---
|
|
|
|
**Last Updated**: 2024-11-25
|
|
**Module Version**: 1.0.0
|
|
**Documentation Version**: 1.0.0
|
|
|
|
## Quick Links
|
|
|
|
- [README.md](README.md) - Module overview
|
|
- [INSTALL.md](INSTALL.md) - Installation guide
|
|
- [USER_GUIDE.md](USER_GUIDE.md) - User documentation
|
|
- [CHANGELOG.md](CHANGELOG.md) - Version history
|
|
- [static/description/index.html](static/description/index.html) - Web documentation
|
|
|
|
---
|
|
|
|
**Need help?** Start with the [README.md](README.md) or [USER_GUIDE.md](USER_GUIDE.md)!
|