# Documentation Onboarding Guide

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

Quick start guide for new team members working with Ordio documentation.

## Quick Start

### First Steps

1. **Read Master Index** - Start with [docs/README.md](README.md)
2. **Review Standards** - Read [DOCUMENTATION_STANDARDS.md](DOCUMENTATION_STANDARDS.md)
3. **Understand Process** - Review [DOCUMENTATION_MAINTENANCE_PROCESS.md](DOCUMENTATION_MAINTENANCE_PROCESS.md)

### Finding Documentation

**For Tools:**

- Inventory: `docs/content/tools/TOOLS_INVENTORY.md`
- Individual docs: `docs/content/tools/[tool-slug]-documentation.md`

**For Pages:**

- Comparison pages: `docs/content/pages/comparison-pages/`
- Product pages: `docs/content/pages/product-pages/`
- Industry pages: `docs/content/pages/industry-pages/`

**For Competitors:**

- Inventory: `docs/content/competitors/COMPETITORS_INVENTORY.md`
- Profiles: `docs/content/competitors/[competitor-slug]-profile.md`

**For Features:**

- Inventory: `docs/content/product-features/PRODUCT_FEATURES_INVENTORY.md`
- Docs: `docs/content/product-features/[feature-slug]-documentation.md`

## Common Tasks

### Updating Existing Documentation

1. Find documentation using patterns above
2. Read existing file completely
3. Update content following standards
4. Update "Last Updated" date (use accurate date)
5. Update cross-references
6. Run validation: `python3 scripts/documentation/validate-links.py`

### Creating New Documentation

1. **Search first** - Check [DOCUMENTATION_INVENTORY.md](DOCUMENTATION_INVENTORY.md)
2. **Check gaps** - [DOCUMENTATION_GAPS.md](DOCUMENTATION_GAPS.md) (pointer + archived analyses)
3. **Follow standards** - Use templates from [DOCUMENTATION_STANDARDS.md](DOCUMENTATION_STANDARDS.md)
4. **Add to inventory** - Update relevant inventory files
5. **Create cross-references** - Link from related docs

### Finding Cursor Rules

- Rule index: `.cursor/rules/README.md`
- Decision tree included in index
- All rules: `.cursor/rules/*.mdc`

## Documentation Structure

```
docs/
├── README.md                          # Overview + quick navigation
├── DOCUMENTATION_MASTER_INDEX.md    # Browse by category
├── DOCUMENTATION_HYGIENE_LOG.md      # Doc maintenance SSOT
├── DOCUMENTATION_INVENTORY.md         # Generated file list
├── DOCUMENTATION_STANDARDS.md         # Standards and conventions
├── DOCUMENTATION_MAINTENANCE_PROCESS.md  # Update workflows
├── DOCUMENTATION_GAPS.md              # Pointer to gaps + archive
├── AI_AGENT_GUIDE.md                  # Cursor AI guide
├── archive/                           # Historical audits & one-off reports
│
├── content/                           # Content-specific docs
│   ├── tools/                         # Tool documentation
│   ├── pages/                         # Page documentation
│   ├── competitors/                   # Competitor profiles
│   ├── product-features/              # Feature documentation
│   └── blog/                          # Blog inventory
│
├── systems/                           # System documentation
├── guides/                            # User guides
├── reference/                         # Technical reference
├── development/                       # Developer docs
└── ai/                                # AI agent docs
```

## Key Principles

1. **Always search first** - Don't create duplicate documentation
2. **Update existing docs** - Prefer updating over creating new
3. **Follow naming conventions** - Use standard file naming
4. **Update dates accurately** - Never use placeholder dates
5. **Create cross-references** - Link related documentation
6. **Run validation** - Check links and dates before committing

## Validation Commands

```bash
# Validate links
python3 scripts/documentation/validate-links.py

# Check dates
python3 scripts/documentation/update-dates.py --check

# Find documentation
python3 scripts/documentation/find-documentation.py "search term"

# Generate inventory + redundancy report (JSON required for the latter)
python3 scripts/documentation/inventory-documentation.py
python3 scripts/documentation/check-redundancy.py
```

## Related Documentation

- **[Documentation Standards](DOCUMENTATION_STANDARDS.md)** - File naming and structure
- **[Maintenance Process](DOCUMENTATION_MAINTENANCE_PROCESS.md)** - Update workflows
- **[AI Agent Guide](AI_AGENT_GUIDE.md)** - Cursor AI discovery patterns
- **[Contributing Guidelines](CONTRIBUTING.md)** - Contribution process