help/ — User-Facing Help Articles

Read this when: adding, editing, reorganizing, or generating help articles. Also read when code changes affect user-facing features — articles may need creating or updating.

955+ markdown articles documenting the entire VIDIZMO product suite for end users. Covers how-to guides, conceptual deep dives, troubleshooting, deployment, configuration, and release notes. Consumed by the helpsite/ Docusaurus site for rendering.

Rules & Conventions

Front Matter (HTML Comments, NOT YAML)

Every article MUST start with these HTML comment lines (in this order):

<!-- ProductTypes:EnterpriseTube,EVCM Legacy,Digital Evidence Management,DEM Legacy,Redaction,Redactor Legacy -->
<!-- LastModified:2026-01-23 14:00:00 -->
<!-- Images for this document are in folder: 584 -->

• ProductTypes — comma-separated, no spaces after commas. Include only products this article applies to. An article missing ProductTypes may not appear on any documentation site.
• LastModified — format is ALWAYS YYYY-MM-DD HH:MM:SS (include time, not just date). Update whenever editing.
• Images folder — numeric ID linking to images/{id}/. Only include if the article has images.

Valid ProductTypes

EnterpriseTube, EVCM Legacy, Digital Evidence Management, DEM Legacy, Redaction, Redactor Legacy

Markdown Conventions

• H1 (#) = article title — one per file, must match filename exactly
• H2–H4 for section hierarchy — never skip levels
• Bold (**text**) for all UI element names: buttons, tabs, fields, menu items, settings
• Notes/callouts: > **Note:** text (blockquote with bold prefix). Also > **Important:** and > **Warning:**
• Images: ![alt text](../../images/{folder-id}/filename.png) — relative paths from article location
• Cross-references: relative markdown links — [Title](filename.md) within same folder, [Title](../../Category/Subcategory/filename.md) across categories. Escape spaces: filename%20with%20spaces.md
• HTML tables: used for complex multi-column layouts (inline styles for formatting)
• Code: inline `code` for config keys, API paths, field names; fenced blocks for multi-line code/config
• No YAML front matter fence (---) — this system uses HTML comments only

Navigation Ordering

_ordering.json controls sidebar navigation. Structure:

{
  "Category Name": ["Article Title 1", "Article Title 2"],
  "Category Name/Subcategory": ["Article Title 1", "Article Title 2"]
}

• Keys = folder paths relative to help/
• Values = ordered arrays of article titles (matching filenames without .md)
• When adding a new article, add its title to the appropriate array
• When renaming an article, update the filename, the H1, AND the _ordering.json entry

File & Folder Naming

• Article filename = article title + .md (spaces allowed)
• Three-way match required: filename (minus .md) = H1 heading = _ordering.json entry
• Category folders = display name (spaces allowed)
• Image folders use numeric IDs under images/ (e.g., images/584/)

---

Article Types & Templates

Type 1: How-To (Procedural)

Filename pattern: How to [Action] in VIDIZMO.md

<!-- ProductTypes:... -->
<!-- LastModified:YYYY-MM-DD HH:MM:SS -->

# How to [Action] in VIDIZMO

[1–2 sentence intro: what this guide covers and why the user would do it.]

## Prerequisites

- Ensure you belong to a group with **[Feature Name]** feature enabled, or have a CAL that grants this feature's permission.
- [Other requirements: config, license, dependencies]

> **Note:** Follow [link to setup guide] to enable [Feature] in your portal.

## Steps to [Action]

### Step 1: [Navigate/Open]

1. Click **[Menu Item]** in the [location].
2. Select **[Option]** from the dropdown.

### Step 2: [Configure/Set Up]

1. In the **[Tab Name]** tab, enter [value] in the **[Field Name]** field.
2. Select **[Save]**.

> **Note:** [Constraint or additional context]

## See Also

- [Related How-To Article](filename.md)
- [Related Understanding Article](../../Category/filename.md)

Rules: Imperative voice ("Click", "Select", "Enter"). One action per numbered step. Bold all UI element names. Include Prerequisites. End with See Also.

Type 2: Understanding (Conceptual)

Filename pattern: Understanding [Concept] in VIDIZMO.md

<!-- ProductTypes:... -->
<!-- LastModified:YYYY-MM-DD HH:MM:SS -->

# Understanding [Concept] in VIDIZMO

[Opening paragraph addressing the problem/pain point this concept solves.]

## Concepts

[High-level explanation of what the feature is, how it works, and when to use it.]

### [Variation/Aspect A]

[Detail about this specific variation.]

### [Variation/Aspect B]

[Detail about this specific variation.]

## Use Cases

### [Scenario Name]

[Real-world application of the concept.]

## Key Considerations

- [Limitation or tradeoff]
- [Language/browser/platform support notes]
- [Best practices]

## See Also

- [How to Use This Feature](filename.md)
- [Related Concept](../../Category/filename.md)

Rules: Explanatory tone (not prescriptive). Open with problem statement. Include use cases where applicable. Document limitations.

Type 3: Troubleshooting

Filename pattern: [Problem Description].md

<!-- ProductTypes:... -->
<!-- LastModified:YYYY-MM-DD HH:MM:SS -->

# [Problem Description]

## Symptom

[What the user observes — describe the visible behavior.]

## Cause

[Technical reason for the problem.]

## Solution

[Steps to fix or work around the issue.]

Rules: Keep concise and direct. Symptom → Cause → Solution structure. Include code blocks if applicable.

Type 4: Release Notes

Filename pattern: Version X.X.X.md (in Release Notes/ category)

<!-- ProductTypes:... -->
<!-- LastModified:YYYY-MM-DD HH:MM:SS -->

# Version X.X.X

[Release date, e.g., "12 Jan 2026"]

[1–2 sentence summary of the release.]

## What's New

- **[Feature Name]:** Brief description of new capability.

## Enhancements

- **[Enhancement Name]:** What improved and why it matters.

## Bug Fixes

- **[Fix Description]:** What was broken and what was fixed.

Rules: Sections always in order: What's New → Enhancements → Bug Fixes. Omit empty sections. Bold feature names, regular text for descriptions.

---

Writing When Code Changes

When a code change affects user-facing behavior, determine which articles need updating or creating:

Mapping Code Changes to Articles

Code Change	Article Action
New feature/screen added	Create How-To + Understanding articles
Existing feature behavior changed	Update affected How-To steps and Understanding explanations
New configuration/setting added	Update relevant How-To (add setting steps) or create new one
Permission/access control changed	Update Prerequisites in affected How-To articles
Bug fixed that users reported	Update or remove related Troubleshooting article
API endpoint added/changed	Update Developer Guide articles if user-facing
UI renamed (button, tab, menu)	Search articles for old name, update all references
Feature removed/deprecated	Mark article with deprecation note or remove + update _ordering.json

How to Find Affected Articles

1. Search by feature name: grep -r "Feature Name" help/ across all articles
2. Search by UI element: Bold terms like **Button Name** in articles correspond to UI elements
3. Check category: Most features map to one primary category (e.g., player changes → VIDIZMO Player/, upload changes → Media Management/)
4. Check cross-references: An updated article may be linked from others — verify links still make sense

Creating a New Article

1. Determine article type (How-To, Understanding, Troubleshooting)
2. Choose the correct category folder (create subcategory if needed)
3. Write using the template above — match tone and depth of existing articles in that category
4. Add front matter with correct ProductTypes (check which products the feature applies to)
5. Add entry to _ordering.json in the appropriate category array
6. Add See Also cross-references to/from related existing articles
7. If images needed: create a new numeric folder under images/ (check existing max ID first)

Updating an Existing Article

1. Read the full article first to understand its current scope
2. Make targeted edits — don't rewrite sections that haven't changed
3. Update <!-- LastModified:... --> to current date/time
4. If renaming: update filename, H1, AND _ordering.json (three-way match)
5. Check cross-references from other articles — update if the renamed article is linked elsewhere

Tone & Voice

• Professional but accessible — not overly technical, precise terminology
• Imperative for How-To — "Click", "Select", "Enter", "Navigate to"
• Explanatory for Understanding — "allows", "enables", "provides", "solves"
• Direct for Troubleshooting — "This occurs because...", "To resolve this..."
• UI elements always bold — Save, Settings, Media Library, Basic Settings tab

---

Gotchas

• Three-way match: Filename (minus .md) = H1 heading = _ordering.json entry. Mismatch breaks navigation.
• Image folder IDs are not sequential: Check existing folders to find next available ID
• helpsite/ is the renderer: help/ is source markdown; helpsite/ (Docusaurus) builds and serves it. Don't confuse the two.
• Space escaping in links: Cross-category links need %20 for spaces in filenames
• ProductTypes controls visibility: Wrong or missing ProductTypes = article invisible on some/all doc sites
• Configurable terminology: VIDIZMO uses a Thesaurus system — "Mashup" may be called "Video", "Course", "Case", etc. depending on the product. Use the product-appropriate term in articles (e.g., "Media" for EnterpriseTube, "Evidence" for DEM).

Key Files

• _ordering.json — navigation sidebar ordering for all categories and articles
• images/ — all article images, organized by numeric folder ID

Structure (22 Categories)

help/
├── _ordering.json
├── images/{numeric-id}/
├── Content Management/          # AI processing, chapters, OCR, object detection
├── Control Panel/               # Admin settings, portal configuration
├── Deployment and Maintenance/  # Installation, upgrades, infrastructure
├── Desktop Application/         # Electron desktop app
├── Developer Guide/             # API, widgets, integrations
├── Digital Evidence Management/ # DEM-specific workflows
├── Frequently Asked Questions/  # Common questions
├── Getting Started with VIDIZMO/# Onboarding, accounts, portals
├── Integration and Customization/# SSO, LMS, third-party integrations
├── Intelligence Hub/            # AI insights, analytics
├── Interactive Media Elements/  # Quizzes, surveys, annotations
├── Live Streaming/              # Webcasting, live events
├── Media Management/            # Upload, publish, organize, share
├── Portal Customization/        # Branding, themes, layouts
├── Release Notes/               # Version history (per release)
├── Security and Incident Response/# Access control, compliance
├── Studio Space/                # In-browser media editor
├── Troubleshoot/                # Known issues and fixes
├── User Management/             # Users, groups, roles, permissions
├── VIDIZMO Analytics and Reporting/# Dashboards, reports
└── VIDIZMO Player/              # Player features, controls, embeds

Did you find this article helpful?

Sorry we couldn't be helpful. Help us improve this article with your feedback.

Your email*

Your feedback*

Need more information

Difficult to understand

Inaccurate/irrelevant content

Missing/broken link

Glad we could be helpful. Thanks for the feedback.

Your response has been recorded. Thank you for the feedback.