Live verification

Summary

Live verification is the process of confirming, in real time, that a document’s hierarchical structure, metadata, and any embedded assets (e.g., images, figures) are correctly preserved and rendered. It is commonly used in content‑management systems, collaborative editing platforms, and automated documentation pipelines to ensure integrity before publishing or archiving.

Key Points

• Purpose: Detect broken links, missing metadata, or corrupted embedded figures early.
• Scope: Checks hierarchy (headings, nested sections), document‑level metadata, and embedded media.
• Automation: Often integrated into CI/CD or document‑generation workflows.
• Outcome: Guarantees that end‑users receive a fully functional and accurately structured document.

Concepts

• Hierarchy preservation: Verifying that heading levels and nesting remain as author‑intended.
• Metadata integrity: Ensuring fields such as creator, creation date, and custom tags are intact.
• Embedded asset validation: Confirming that images, diagrams, and other media load correctly and match expected dimensions or checksums.
• Live check: Performed on the fly, typically as part of a preview or build step, rather than a post‑mortem audit.

Details

Live verification typically follows these steps:

1. Parse Document Structure

   • Traverse the document tree (e.g., Markdown AST, HTML DOM).
   • Record heading levels and nesting to confirm expected hierarchy.

2. Extract and Compare Metadata

   • Read front‑matter (YAML, TOML, JSON) or system‑generated headers.
   • Compare values against a source of truth (e.g., version control tags, schema).

3. Validate Embedded Assets

   • Locate all asset references (e.g., ![Alt text](image.png)).
   • Verify file existence, accessibility, and, if required, checksum or resolution.
   • For vector or diagram assets, optionally render a test thumbnail to catch rendering errors.

4. Report Findings

   • Generate a concise report listing any mismatches, missing files, or hierarchy violations.
   • Include line numbers or section identifiers for quick remediation.

5. Integrate with Workflow

   • Hook the verification script into CI pipelines (npm run verify-docs, GitHub Actions, Azure DevOps).
   • Fail the build on critical errors, but allow warnings for non‑blocking issues.

Example Automation Snippet (pseudo‑code)

# .github/workflows/doc-verification.yml
name: Document Live Verification
on: [push, pull_request]
jobs:
  verify:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install verifier
        run: pip install doc-verifier
      - name: Run live verification
        run: doc-verifier verify ./docs/**/*.md --fail-on-error

Benefits

• Early defect detection reduces rework after release.
• Consistency across multiple contributors and document versions.
• Compliance with standards that require complete metadata (e.g., ISO 9001 documentation).
• User confidence that published materials are visually and structurally intact.

Limitations

• Requires up‑to‑date reference data (metadata schemas, asset manifests).
• May increase build time for large documentation sets; incremental checks can mitigate this.

By incorporating live verification into the documentation lifecycle, teams ensure that every piece of content remains reliable, searchable, and correctly formatted from authoring through delivery.

Source figures

yopedia-live-source-test.docx

Paragraph 2 · embedded in yopedia-live-source-test.docx

See also: Yopedia inbound email receipt path verification