---
description: Documentation standards for LabFusion project
globs: ["**/*.md", "**/README.md", "**/CLEAN_CODE.md", "**/RESILIENCE.md"]
alwaysApply: true
---

# Documentation Standards

## README Requirements
Every service and major component MUST have a comprehensive README.md file that includes:

### Service README Requirements
- **Service Overview**: Purpose, port, and main functionality
- **Architecture**: Key components and their responsibilities
- **Features**: Core capabilities and integrations
- **API Endpoints**: Available endpoints with descriptions
- **Configuration**: Environment variables and settings
- **Development**: Setup, running, and testing instructions
- **Dependencies**: Required packages and versions
- **Clean Code**: Reference to CLEAN_CODE.md file

### Frontend README Requirements
- **Component Structure**: Directory organization and component hierarchy
- **Development Setup**: Installation and running instructions
- **Architecture**: Clean code principles and patterns
- **API Integration**: Service communication and error handling
- **Offline Mode**: Resilience features and fallback behavior
- **Testing**: Unit and integration testing guidelines

## Documentation Folder Structure
The `docs/` folder MUST contain:

### Required Files
- **specs.md**: Project specifications and requirements
- **structure.txt**: Complete project directory structure
- **progress.md**: Development progress and completed tasks
- **FRONTEND_REFACTORING.md**: Frontend clean code refactoring summary

### Documentation Updates
- Update `structure.txt` when adding new files or directories
- Update `progress.md` when completing tasks or milestones
- Update service-specific READMEs when modifying functionality
- Update main README.md when adding new features or services

## Clean Code Documentation
Every service MUST have a CLEAN_CODE.md file that includes:

### Required Sections
- **Architecture Overview**: Service structure and organization
- **Clean Code Principles**: SRP, OCP, DIP, ISP applications
- **Code Quality Improvements**: Before/after examples
- **Best Practices**: Technology-specific guidelines
- **Performance Optimizations**: Caching, async operations, etc.
- **Testing Strategy**: Unit, integration, and E2E testing
- **Code Review Checklist**: Quality assurance guidelines
- **Future Improvements**: Enhancement roadmap

## Documentation Quality Checklist

### README Quality
- [ ] Clear service overview and purpose
- [ ] Complete setup and running instructions
- [ ] API endpoint documentation
- [ ] Configuration examples
- [ ] Development guidelines
- [ ] Links to related documentation

### Clean Code Documentation
- [ ] Architecture overview included
- [ ] Clean code principles explained
- [ ] Code examples provided
- [ ] Best practices documented
- [ ] Testing strategies outlined
- [ ] Future improvements listed

### Project Documentation
- [ ] Structure.txt is up to date
- [ ] Progress.md reflects current status
- [ ] All services have README files
- [ ] All services have CLEAN_CODE.md files
- [ ] Main README.md is comprehensive