# Documentation Update Checklists

**Last Updated:** 2026-01-08

Quick reference checklists for updating different types of documentation.

## Competitor Profile Update Checklist

When updating a competitor profile:

- [ ] Update "Last Updated" date (use `date +%Y-%m-%d`)
- [ ] Verify competitor information is current
- [ ] Check pricing information
- [ ] Update features list if changed
- [ ] Review comparison with Ordio
- [ ] Verify all links work
- [ ] Check cross-references
- [ ] Update inventory if needed

## Product Feature Documentation Update Checklist

When updating product feature documentation:

- [ ] Update "Last Updated" date
- [ ] Verify feature status (Available/Coming Soon/Beta)
- [ ] Update use cases if new ones added
- [ ] Update technical implementation details
- [ ] Verify file paths are correct
- [ ] Update API endpoints if changed
- [ ] Review user flow documentation
- [ ] Update inventory

## Page Documentation Update Checklist

When updating page documentation:

- [ ] Update "Last Updated" date
- [ ] Verify page structure matches current implementation
- [ ] Update hero section content
- [ ] Review content sections
- [ ] Update CTAs if changed
- [ ] Verify meta tags are current
- [ ] Check schema.org data
- [ ] Update inventory

## Tool Documentation Update Checklist

When updating tool documentation:

- [ ] Update "Last Updated" date
- [ ] Verify calculation logic is accurate
- [ ] Update FAQs if needed
- [ ] Check legal compliance requirements
- [ ] Verify year-specific values (e.g., tax rates)
- [ ] Update technical implementation
- [ ] Review content structure
- [ ] Run validation scripts

## Data Source Update Process

### Competitor Data

1. **Source:** `v2/data/optimized_comparison_data.php`
2. **Extract:** Run `extract-competitor-data.py`
3. **Update:** Modify PHP data file
4. **Regenerate:** Run extraction script again
5. **Update Docs:** Regenerate competitor profiles if needed

### Product Feature Data

1. **Source:** `v2/pages/product_*.php`
2. **Extract:** Run `extract-product-feature-data.py`
3. **Update:** Modify PHP files
4. **Regenerate:** Run extraction script again
5. **Update Docs:** Regenerate feature documentation if needed

### Page Content Data

1. **Source:** `v2/pages/compare_*.php`, `v2/pages/product_*.php`, `v2/pages/industry_*.php`
2. **Extract:** Run `extract-page-content-data.py`
3. **Update:** Modify PHP files
4. **Regenerate:** Run extraction script again
5. **Update Docs:** Regenerate page documentation if needed

## Validation Checklist

After any documentation update:

- [ ] Run `validate-links.py`
- [ ] Run `validate-cross-references.py`
- [ ] Check for broken internal links
- [ ] Verify cross-references work
- [ ] Check date accuracy
- [ ] Verify template adherence
- [ ] Run `check-redundancy.py` if creating new files

## Related Documentation

- [Documentation Maintenance Process](DOCUMENTATION_MAINTENANCE_PROCESS.md) - Complete workflows
- [Documentation Generation Scripts](DOCUMENTATION_GENERATION_SCRIPTS.md) - Script reference
- [Documentation Standards](DOCUMENTATION_STANDARDS.md) - File naming and structure