Phase 5: Documentation for Conflict Resolver Agent
Overview
Create comprehensive documentation for users and developers covering the Conflict Resolver agent.
Tasks
User Documentation
-
Update
doc/user/project/merge_requests/conflicts.md - Add "Resolve conflicts with AI" section
- Explain when to use the feature
- Document prerequisites (Duo license, permissions, etc.)
- Provide step-by-step usage instructions
- Include example interactions
- Explain confidence levels
- Document how to apply resolutions
- Add troubleshooting section
- Add limitations section
Developer Documentation
-
Create
doc/development/ai_features/conflict_resolver_agent.md - Document architecture and components
-
Explain tool implementation (
get_merge_request_conflicts) - Document agent configuration
- Explain data structures and flow
- Provide testing guidelines
- Document monitoring and metrics
- Add troubleshooting guide for developers
API Documentation (if needed)
- Update tool catalog documentation
- Document tool input/output schemas
- Add examples of tool calls
Visual Assets
- Create screenshots of the button
- Create screenshot of chat interaction
- Create flow diagram (optional)
- Add to documentation
Internal Documentation
- Update architecture diagrams if needed
- Document feature flags
- Document rollout plan
- Add to Duo Chat feature inventory
Review and Validation
- Technical writer review
- Engineering review
- Product manager review
- Test all documented procedures
- Verify all links work
Acceptance Criteria
- User documentation is clear and complete
- Developer documentation covers implementation details
- Screenshots/visuals are included
- All procedures have been tested
- Technical writer has approved
- Documentation is accessible at correct URLs
Documentation Sections
User Docs Should Cover:
- What is the Conflict Resolver agent?
- When should you use it?
- Prerequisites and setup
- How to access and use
- Example workflows
- Understanding agent responses
- Applying suggestions
- Troubleshooting
- Limitations and when to manually review
Developer Docs Should Cover:
- Architecture overview
- Component descriptions (tool, agent, UI)
- Implementation details
- Data structures
- Testing approach
- Monitoring and metrics
- Troubleshooting
- Future enhancements
Files Changed
doc/user/project/merge_requests/conflicts.mddoc/development/ai_features/conflict_resolver_agent.md- Visual assets in
doc/user/project/merge_requests/img/
Timeline
1 day
Related to epic &20688