Skip to content

Z618: REQUIRED_HEADING_PATTERN

  • Severity: Error

    Penalty: 0.0 points | Category: general

  • Remediation & Opt-In

    Auto-Fixable: No | Opt-In: No

Description

A document does not contain any heading matching a required regular expression pattern declared in [policies].required_heading_patterns.

This policy enforces standardized document templates and structure (for example, ensuring that every guide includes an Overview or Prerequisites section).

How to Fix

Add the missing section heading matching the required pattern to the document.

Configuration

Declare required heading patterns in .zenzic.toml:

[policies]
required_heading_patterns = ["^Overview$", "^Prerequisites$"]

Suppression

Suppress with an inline comment:

<!-- zenzic:ignore:Z618 -->

Reference

See the Finding Codes Index for finding code details.