# Documentation Update Checklist

**Last Updated:** 2026-01-10

Checklist for maintaining and updating documentation when making code changes.

## When Adding a New Form Endpoint

- [ ] Add endpoint to `docs/systems/forms/FORM_TO_PAGE_MAPPING.md`
- [ ] Add form configuration to `docs/systems/forms/FORM_CONFIGURATION_REFERENCE.md`
- [ ] Document API endpoint in `docs/systems/apis/HUBSPOT_API_REFERENCE.md`
- [ ] Add data flow diagram to `docs/systems/forms/DATA_FLOW_DIAGRAMS.md` (if new flow)
- [ ] Update `docs/systems/DEVELOPER_QUICK_REFERENCE.md` if needed
- [ ] Update Cursor rules if pattern changes

## When Adding a New Shared Component

- [ ] Create component documentation in `docs/systems/shared-components/`
- [ ] Add component to `docs/systems/shared-components/README.md`
- [ ] Update `docs/systems/shared-components/COMPONENT_USAGE_GUIDE.md`
- [ ] Add JSDoc/PHPDoc comments to code
- [ ] Update `docs/systems/DEVELOPER_QUICK_REFERENCE.md`

## When Modifying an Existing Component

- [ ] Update component documentation
- [ ] Update "Last Updated" date in documentation
- [ ] Update code examples if API changes
- [ ] Check if usage guide needs updates
- [ ] Verify cross-references still work

## When Adding a New Page Type

- [ ] Document form integration pattern
- [ ] Add to form-to-page mapping if uses forms
- [ ] Update component usage guide if new pattern
- [ ] Add to developer quick reference

## When Updating HubSpot Integration

- [ ] Update `docs/systems/apis/HUBSPOT_API_REFERENCE.md`
- [ ] Update `docs/systems/forms/FORM_CONFIGURATION_REFERENCE.md`
- [ ] Update `docs/guides/HUBSPOT_INTEGRATION_GUIDE.md`
- [ ] Verify form GUIDs are correct
- [ ] Test integration and document any changes

## Before Committing Documentation Changes

- [ ] Update "Last Updated" date (YYYY-MM-DD format)
- [ ] Verify all links work (use link checker)
- [ ] Check code examples are accurate
- [ ] Ensure cross-references are updated
- [ ] Run validation script if available

## Quarterly Documentation Review

- [ ] Review all "Last Updated" dates
- [ ] Check for broken links
- [ ] Verify code examples still work
- [ ] Update outdated information
- [ ] Consolidate redundant documentation
- [ ] Archive outdated documentation

## Related Documentation

- **[Documentation Standards](../DOCUMENTATION_STANDARDS.md)** - Documentation conventions
- **[Documentation Maintenance Process](../DOCUMENTATION_MAINTENANCE_PROCESS.md)** - Maintenance workflows
- **[Developer Quick Reference](DEVELOPER_QUICK_REFERENCE.md)** - Quick reference guide
