bmad-odoo-dev

# Odoo Module Development Checklist ## Pre-Development Phase ### Requirements Analysis - [ ] Business requirements clearly documented and approved - [ ] Technical architecture reviewed and approved - [ ] Module scope and boundaries defined - [ ] Dependencies on other modules identified - [ ] User roles and permissions requirements specified - [ ] Integration requirements documented - [ ] Performance requirements defined - [ ] Security requirements specified ### Environment Setup - [ ] Development environment set up with correct Odoo version - [ ] Git repository initialized with proper branching strategy - [ ] Code quality tools configured (flake8, pylint-odoo, pre-commit) - [ ] Testing framework set up - [ ] Documentation structure created - [ ] Backup procedures tested ## Module Structure Phase ### Basic Module Structure - [ ] Module directory created with proper naming convention - [ ] `__init__.py` files created in all necessary directories - [ ] `__manifest__.py` file created with proper metadata - [ ] Directory structure follows Odoo conventions: ``` module_name/ ├── __init__.py ├── __manifest__.py ├── models/ ├── views/ ├── security/ ├── data/ ├── demo/ ├── static/ ├── tests/ └── README.rst ``` ### Manifest File (`__manifest__.py`) - [ ] Module name follows naming conventions - [ ] Version number is appropriate for target Odoo version - [ ] Category is correctly specified - [ ] Author includes OCA reference (if applicable) - [ ] License is specified (AGPL-3 for OCA modules) - [ ] Dependencies are correctly listed - [ ] Data files are listed in correct order - [ ] Demo data files are properly specified - [ ] External dependencies are documented - [ ] Module is marked as installable - [ ] Auto-install is set appropriately ## Model Development Phase ### Model Definition - [ ] Model name follows naming conventions (`module.model`) - [ ] Model description is clear and meaningful - [ ] Proper inheritance pattern used (`_inherit` vs `_inherits`) - [ ] Table name is appropriate (for `_name` models) - [ ] Record name field (`_rec_name`) is specified if needed - [ ] Default order (`_order`) is defined appropriately - [ ] Required mixins are inherited (`mail.thread`, `mail.activity.mixin`) ### Field Definitions - [ ] Field names are descriptive and follow conventions - [ ] Field types are appropriate for data being stored - [ ] Required fields are properly marked - [ ] String labels are user-friendly and translatable - [ ] Help text is provided for complex fields - [ ] Default values are set where appropriate - [ ] Selection field options are comprehensive - [ ] Related fields are properly configured - [ ] Computed fields have proper dependencies - [ ] Store parameter is used appropriately for computed fields ### Model Methods - [ ] CRUD methods (`create`, `write`, `unlink`) are properly overridden - [ ] Business logic is implemented in appropriate methods - [ ] API decorators are used correctly (`@api.depends`, `@api.constrains`) - [ ] Method names follow conventions - [ ] Methods have proper docstrings - [ ] Error handling is implemented - [ ] User-friendly error messages are provided - [ ] Methods handle recordsets properly ### Constraints and Validations - [ ] SQL constraints are defined where appropriate - [ ] Python constraints are implemented for complex validations - [ ] Unique constraints are properly defined - [ ] Foreign key constraints are considered - [ ] Data integrity is maintained - [ ] Validation error messages are user-friendly - [ ] Performance impact of constraints is considered ## View Development Phase ### Form Views - [ ] Form structure is logical and user-friendly - [ ] Header section includes appropriate buttons and statusbar - [ ] Fields are properly grouped and organized - [ ] Notebook structure is used for complex forms - [ ] Invisible and readonly conditions are properly set - [ ] Required field indicators are shown - [ ] Field widgets are appropriate for data types - [ ] Chatter is included for mail.thread models - [ ] Form follows Odoo UI/UX guidelines ### Tree/List Views - [ ] Important fields are visible in tree view - [ ] Field order is logical for user workflow - [ ] Decorations are used to highlight important states - [ ] Grouping is configured where appropriate - [ ] Sorting is configured appropriately - [ ] Column widths are reasonable - [ ] Handle widget is used for sequence fields - [ ] Actions are available where needed ### Search Views - [ ] Key fields are available for search - [ ] Filters are provided for common use cases - [ ] Group by options are logical - [ ] Default filters are set appropriately - [ ] Search filters are clearly labeled - [ ] Advanced search options are available - [ ] Filter combinations work correctly ### Menu and Actions - [ ] Menu structure is logical and follows Odoo patterns - [ ] Menu items have appropriate sequence - [ ] Actions are properly configured - [ ] Context and domain are set appropriately - [ ] Help text is provided for actions - [ ] Access rights are properly set - [ ] Icons are appropriate and consistent ## Security Implementation Phase ### User Groups - [ ] User groups are business-oriented and logical - [ ] Group hierarchy is properly designed - [ ] Group categories are appropriate - [ ] Implied groups are set correctly - [ ] Group descriptions are clear - [ ] Demo data includes proper group assignments ### Access Rights (`ir.model.access.csv`) - [ ] All models have appropriate access rights - [ ] CRUD permissions are properly set - [ ] Access rights follow principle of least privilege - [ ] Manager groups have appropriate elevated permissions - [ ] System administrator access is considered - [ ] Multi-company access is handled appropriately ### Record Rules - [ ] Record-level security is implemented where needed - [ ] Rules are properly scoped to user groups - [ ] Domain filters are correctly written - [ ] Multi-company rules are implemented - [ ] Performance impact is considered - [ ] Global rules are used appropriately - [ ] Rule combinations work correctly ### Field-Level Security - [ ] Sensitive fields have appropriate restrictions - [ ] Field groups are used for advanced permissions - [ ] Read-only conditions are properly implemented - [ ] Field visibility is controlled appropriately ## Integration and API Phase ### External Integrations - [ ] API endpoints are properly secured - [ ] Authentication mechanisms are implemented - [ ] Input validation is comprehensive - [ ] Error handling is robust - [ ] Rate limiting is considered - [ ] API documentation is complete - [ ] Integration testing is thorough ### Internal Integrations - [ ] Module dependencies are minimal and appropriate - [ ] Integration points are well-defined - [ ] Data flow between modules is efficient - [ ] Circular dependencies are avoided - [ ] Module interfaces are stable - [ ] Backward compatibility is maintained ## Data Management Phase ### Master Data - [ ] Demo data is comprehensive and realistic - [ ] Data files are properly structured - [ ] XML data follows Odoo conventions - [ ] CSV imports are efficient and reliable - [ ] Data migration scripts are tested - [ ] Data integrity is maintained ### Configuration Data - [ ] System parameters are properly configured - [ ] Email templates are created where needed - [ ] Scheduled actions are properly configured - [ ] Server actions are implemented correctly - [ ] Report templates are created - [ ] Workflow configurations are complete ## Testing Phase ### Unit Testing - [ ] Test files are properly structured - [ ] Test coverage is adequate (>80% for custom code) - [ ] All business logic is tested - [ ] Edge cases are covered - [ ] Error conditions are tested - [ ] Test data setup is efficient - [ ] Tests are independent and repeatable - [ ] Test names are descriptive ### Integration Testing - [ ] Module integration is tested - [ ] View rendering is tested - [ ] Form submissions are tested - [ ] Security rules are tested - [ ] API endpoints are tested - [ ] External integrations are tested - [ ] Performance is tested with realistic data ### Manual Testing - [ ] All user workflows are tested manually - [ ] UI/UX is validated by business users - [ ] Error messages are user-friendly - [ ] Performance is acceptable - [ ] Cross-browser compatibility is verified - [ ] Mobile responsiveness is tested - [ ] Accessibility is validated ## Code Quality Phase ### Code Standards - [ ] Code follows PEP 8 standards - [ ] Pylint-odoo checks pass without warnings - [ ] Flake8 checks pass - [ ] Code is properly formatted - [ ] Import statements are organized - [ ] No unused imports or variables - [ ] No debug statements left in code ### Documentation - [ ] All public methods have docstrings - [ ] Complex logic is commented - [ ] README.rst is complete and accurate - [ ] API documentation is generated - [ ] User documentation is available - [ ] Installation instructions are clear - [ ] Known issues are documented ### Performance - [ ] Database queries are optimized - [ ] N+1 query problems are avoided - [ ] Indexes are created where needed - [ ] Large datasets are handled efficiently - [ ] Memory usage is reasonable - [ ] CPU usage is optimized - [ ] Response times meet requirements ## Deployment Phase ### Pre-Deployment - [ ] Module is tested in staging environment - [ ] Database migration scripts are tested - [ ] Backup procedures are verified - [ ] Rollback plan is prepared and tested - [ ] Deployment checklist is prepared - [ ] Stakeholder approval is obtained ### Deployment - [ ] Module installs without errors - [ ] Data migration completes successfully - [ ] All views render correctly - [ ] Security rules are applied correctly - [ ] Integration points work correctly - [ ] Performance is acceptable in production - [ ] No regression in existing functionality ### Post-Deployment - [ ] Smoke tests pass - [ ] User acceptance testing is completed - [ ] Performance monitoring is active - [ ] Error logging is configured - [ ] Support documentation is available - [ ] Training is provided to users - [ ] Feedback collection is active ## Maintenance Phase ### Ongoing Maintenance - [ ] Update procedures are documented - [ ] Compatibility with new Odoo versions is maintained - [ ] Security patches are applied promptly - [ ] Performance is monitored regularly - [ ] User feedback is collected and addressed - [ ] Bug fixes are tested thoroughly - [ ] Documentation is kept current ### Version Management - [ ] Version numbering follows semantic versioning - [ ] Release notes are maintained - [ ] Migration guides are provided - [ ] Backward compatibility is maintained - [ ] Breaking changes are properly communicated - [ ] Support lifecycle is defined ## Final Review ### Pre-Release Checklist - [ ] All development checklist items completed - [ ] Code review completed by senior developer - [ ] Architecture review completed - [ ] Security review completed - [ ] Performance review completed - [ ] Documentation review completed - [ ] User acceptance testing completed - [ ] Stakeholder sign-off obtained ### Release Preparation - [ ] Release notes prepared - [ ] Installation guide updated - [ ] Upgrade guide prepared (if needed) - [ ] Support documentation updated - [ ] Training materials prepared - [ ] Communication plan executed - [ ] Deployment plan finalized ## Notes Section **Additional Considerations:** - Module-specific requirements or constraints - Performance benchmarks or targets - Integration-specific validation points - Business-specific validation criteria - Compliance or regulatory requirements **Sign-off:** - [ ] Developer: _________________ Date: _______ - [ ] Code Reviewer: _____________ Date: _______ - [ ] Technical Lead: ____________ Date: _______ - [ ] Product Owner: _____________ Date: _______