# Documentation Generation Scripts

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

Reusable scripts for generating documentation files efficiently.

## Available Scripts

### Competitor Profiles

**Script:** `scripts/documentation/generate-competitor-profile.py`

**Usage:**

```bash
python3 scripts/documentation/generate-competitor-profile.py
```

**Functionality:**

- Generates competitor profile from extracted data
- Uses competitor profile template
- Classifies competitors (direct/indirect/content)
- Adds cross-references and related documentation links

**Output:** `docs/content/competitors/[slug]-profile.md`

### Product Feature Documentation

**Script:** `scripts/documentation/generate-feature-doc.py`

**Usage:**

```bash
python3 scripts/documentation/generate-feature-doc.py
```

**Functionality:**

- Generates product feature documentation from extracted data
- Uses product feature template
- Extracts use cases, technical implementation, user flows
- Adds cross-references

**Output:** `docs/content/product-features/[slug]-documentation.md`

### Page Documentation

**Script:** `scripts/documentation/generate-page-docs.py`

**Usage:**

```bash
python3 scripts/documentation/generate-page-docs.py
```

**Functionality:**

- Generates comparison page documentation
- Generates product page documentation
- Generates industry page documentation
- Uses respective page templates
- Includes page structure, content strategy, maintenance

**Output:**

- `docs/content/pages/comparison-pages/[slug]-documentation.md`
- `docs/content/pages/product-pages/[slug]-documentation.md`
- `docs/content/pages/industry-pages/[slug]-documentation.md`

## Data Extraction Scripts

### Extract Competitor Data

**Script:** `scripts/documentation/extract-competitor-data.py`

**Usage:**

```bash
python3 scripts/documentation/extract-competitor-data.py
```

**Output:** `docs/data/competitors-extracted.json`

### Extract Product Feature Data

**Script:** `scripts/documentation/extract-product-feature-data.py`

**Usage:**

```bash
python3 scripts/documentation/extract-product-feature-data.py
```

**Output:** `docs/data/product-features-extracted.json`

### Extract Tool Data

**Script:** `scripts/documentation/extract-tool-data.py`

**Usage:**

```bash
python3 scripts/documentation/extract-tool-data.py
```

**Output:** `docs/data/tools-extracted.json`

### Extract Page Content Data

**Script:** `scripts/documentation/extract-page-content-data.py`

**Usage:**

```bash
python3 scripts/documentation/extract-page-content-data.py
```

**Output:** `docs/data/pages-extracted.json`

## Workflow

1. **Extract Data:** Run extraction scripts to gather data from PHP files
2. **Generate Documentation:** Run generation scripts to create documentation files
3. **Update Inventories:** Run inventory update scripts
4. **Validate:** Run validation scripts to check quality

## Related Documentation

- [Documentation Templates](DOCUMENTATION_TEMPLATES.md) - All templates
- [Documentation Standards](DOCUMENTATION_STANDARDS.md) - File naming and structure
- [Documentation Maintenance Process](DOCUMENTATION_MAINTENANCE_PROCESS.md) - Update workflows