# Product Features Documentation - Quick Reference

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

Quick reference guide for common product feature documentation tasks.

## Common Tasks

### Find Feature Documentation

```bash
# By feature slug
ls docs/content/product-features/[feature-slug]-documentation.md

# By product page file
grep -r "product_[feature].php" docs/content/product-features/
```

### Validate Documentation

```bash
# Run validation script
python3 scripts/documentation/validate-feature-docs.py

# Check validation report
cat docs/content/product-features/VALIDATION_REPORT.md
```

### Update Last Updated Date

```bash
# Get current date
date +%Y-%m-%d

# Update in file
# Change: **Last Updated:** YYYY-MM-DD
```

### Check Documentation Status

```bash
# View inventory
cat docs/content/product-features/PRODUCT_FEATURES_INVENTORY.md

# View index
cat docs/content/product-features/FEATURE_DOCUMENTATION_INDEX.md
```

## Common Patterns

### Use Case Format

```markdown
### [Use Case Name]

**Scenario:** [Real-world scenario - 1-2 sentences]

**Process:**

1. [Step 1: What user does]
2. [Step 2: What happens next]
3. [Step 3: Final outcome]

**Benefits:** [Specific, measurable outcome]
```

### Target Audience Format

```markdown
### Primary Users

**[User Role]:**

- [Responsibility/need]
- [Benefit they get]
- [How they use the feature]

### Industries

**[Industry]:**

- [Why this industry benefits]
- [Specific use case]
```

### Technical Implementation Format

```markdown
### Files

**Frontend Files:**

- **PHP:** `v2/pages/[file].php` (~[line count] lines)
- **JavaScript:** `v2/js/[file].js` (if exists)
- **CSS:** `/v2/css/[file].min.css`

### API Endpoints

- `METHOD /api/[endpoint]` - [Purpose]
```

## File Locations

### Documentation Files

- **Feature Docs:** `docs/content/product-features/[feature-slug]-documentation.md`
- **Inventory:** `docs/content/product-features/PRODUCT_FEATURES_INVENTORY.md`
- **Index:** `docs/content/product-features/FEATURE_DOCUMENTATION_INDEX.md`
- **Workflow:** `docs/content/product-features/FEATURE_DOCUMENTATION_WORKFLOW.md`

### Product Pages

- **PHP Files:** `v2/pages/product_[feature].php`
- **CSS:** `v2/css/product-pages.min.css`
- **Page Docs:** `docs/content/pages/product-pages/[feature]-documentation.md`

### Cursor Rules

- **Feature Docs Rule:** `.cursor/rules/product-features.mdc`
- **Product Pages Rule:** `.cursor/rules/product-pages.mdc`

## Validation Checklist

Before marking documentation as complete:

- [ ] All 10 required sections present
- [ ] Use cases include Scenario, Process, Benefits
- [ ] Target audience includes primary/secondary users and industries
- [ ] Technical implementation includes files, dependencies, API endpoints
- [ ] User experience includes detailed flows and UI components
- [ ] Visual documentation section present
- [ ] No placeholder text
- [ ] Last Updated date is current
- [ ] Cross-references to related documentation present
- [ ] Links validated (run validation script)

## Common Issues & Quick Fixes

### Missing Sections

**Fix:** Use template from `docs/DOCUMENTATION_TEMPLATES.md`

### Placeholder Text

**Fix:** Replace "to be documented" with actual content. Review similar feature docs.

### Broken Links

**Fix:** Run validation script, fix broken links, verify paths are correct.

### Outdated Dates

**Fix:** Update with `date +%Y-%m-%d`, replace in file.

### Incomplete Use Cases

**Fix:** Expand to include Scenario, Process (numbered steps), and Benefits.

## Related Documentation

- [Feature Documentation Workflow](FEATURE_DOCUMENTATION_WORKFLOW.md) - Complete workflow guide
- [Feature Documentation Index](FEATURE_DOCUMENTATION_INDEX.md) - Complete index
- [Product Features Inventory](PRODUCT_FEATURES_INVENTORY.md) - Feature inventory
- [Documentation Templates](../../DOCUMENTATION_TEMPLATES.md) - Standard templates

## Related Cursor Rules

- [product-features.mdc](../../../.cursor/rules/product-features.mdc) - Feature documentation patterns
- [product-pages.mdc](../../../.cursor/rules/product-pages.mdc) - Product page patterns