Overview
Keeping your knowledge base documents up-to-date is essential for providing accurate information through your voice agents. This guide covers best practices for updating existing documents, managing versions, and maintaining document quality in your AlloMia knowledge base.When to Update Documents
Documents should be updated when:- Information becomes outdated or inaccurate
- Policies or procedures change
- New services or options become available
- Healthcare regulations or guidelines change
- You identify gaps or areas for improvement
- Usage analytics show confusion or frequent questions about the topic
Accessing Documents for Updates
To update an existing document:- Navigate to your knowledge base in the AlloMia dashboard
- Locate the document using:
- Search functionality
- Category browsing
- Filter by tags or status
- Click on the document name to open the document detail view
- Select “Edit” to make changes
Document Update Workflow
Follow these steps for effective document updates:-
Review Current Version:
- Read the entire document to understand its current state
- Note all areas requiring updates
- Check related documents for consistency
-
Make Edits:
- Update inaccurate or outdated information
- Add new relevant content
- Improve clarity and organization if needed
- Ensure formatting remains consistent
-
Add Update Metadata:
- Update the “Last Modified” date
- Add version notes describing changes
- Update any related tags or categories
- Modify status if necessary (Draft, Review, Published)
-
Submit for Review (if applicable):
- For organizations with approval workflows
- Assign to appropriate reviewers
- Include notes about significant changes
-
Publish Updates:
- Once approved, publish the updated document
- Ensure it syncs with connected voice agents
Version Control Best Practices
Maintain proper version history:- In the document detail view, click “Version History”
-
For each update:
- Add descriptive version notes
- Tag major vs. minor updates
- Link to relevant change requests or policies
- Record who approved the changes
-
When viewing version history, you can:
- Compare any two versions
- Restore previous versions if needed
- See who made specific changes
- Track the document’s evolution over time
Batch Updates
For updating multiple documents simultaneously:- From your knowledge base, use checkboxes to select multiple documents
-
Click “Batch Edit” to modify:
- Status
- Categories
- Tags
- Expiration dates
- Review dates
- Access permissions
-
Use “Find and Replace” for content changes across multiple documents:
- Update terminology consistently
- Fix common errors
- Replace outdated information
Scheduling Regular Updates
Implement a systematic update schedule:-
In “Knowledge Base Settings,” configure “Document Maintenance”:
- Set default review frequencies (quarterly, annually, etc.)
- Enable review reminders
- Assign review responsibilities
-
For individual documents, set custom review schedules:
- Critical documents may need more frequent reviews
- Seasonal content should be reviewed before relevant periods
- Regulatory information should align with compliance schedules
Testing Updated Documents
Verify effectiveness after updates:-
Use the “Test Retrieval” feature:
- Enter sample questions related to the updated content
- Verify the updated information is properly retrieved
- Check that related voice agents access the new content
-
Review in context:
- Use “Speak with Agent” to test how the information is used in conversation
- Verify that the agent correctly incorporates the updated information
- Check for any inconsistencies or confusion
Best Practices for Healthcare Document Updates
- Accuracy Verification: Have clinical staff review medical content changes
- Change Documentation: Maintain clear records of what was updated and why
- Version Comparison: Use the comparison tool to highlight exactly what changed
- Coordinated Updates: Update related documents simultaneously for consistency
- Notification System: Alert relevant team members about significant changes
- Archiving Strategy: Archive rather than delete outdated documents
- Update Communication: Inform users about major content changes
- Compliance Tracking: Document how updates align with regulatory requirements
Handling Time-Sensitive Updates
For urgent document changes:-
Use the “Priority Update” feature:
- Flag the document as requiring immediate attention
- Assign reviewers with tight deadlines
- Enable expedited approval workflow
-
Force synchronization with voice agents:
- In document settings, select “Force Sync”
- This ensures voice agents immediately access the updated information
- Monitor initial usage to verify proper implementation
Troubleshooting Update Issues
If you encounter problems with document updates:- Check for locked documents that may require unlocking
- Verify you have proper edit permissions
- Clear your browser cache if changes aren’t appearing
- Check for conflicts if multiple people are editing
- Verify that update notes are being saved properly
- Contact AlloMia support for persistent update issues