prowler-docs_skill

Overview

This skill provides a concise style guide and writing standards for Prowler documentation. It ensures consistent voice, formatting, SEO, and MDX usage when authoring feature docs, tutorials, API references, and release notes. Use it to maintain clarity, inclusivity, and technical accuracy across all Prowler content.

How this skill works

The skill inspects documentation drafts for brand voice, terminology, header capitalization, hyphenation, and bullet structure. It validates MDX snippets such as VersionBadge and Warning/Danger components, checks SEO-friendly sentence placement, and enforces proper noun usage for Prowler features. It flags deviations and suggests edits to align content with the guide.

When to use it

• Writing feature documentation for Prowler App, Prowler CLI, or Prowler Cloud
• Creating API or SDK reference pages and examples
• Authoring tutorials, how-tos, or step-by-step guides
• Drafting release notes for new versions and features

Best practices

• Use an unbiased, inclusive voice; avoid gendered pronouns and broad generalizations
• Define key terms and acronyms on first use (e.g., Identity and Access Management (IAM))
• Use Title Case for all headers and maintain logical H1–H6 hierarchy
• Place keywords near the start of sentences and headers for better SEO
• Follow hyphenation rules: use hyphen in prenominal position, none postnominal
• Use MDX components for version badges and callouts; prefer clear, short code examples

Example use cases

• Documenting a new compliance check added to Built-in Compliance Checks
• Writing an SDK guide demonstrating Prowler SDK usage patterns
• Creating a provider tutorial for AWS, Azure, or GCP under providers/
• Preparing release notes with VersionBadge and feature summaries
• Composing security-hardening how-to guides that include Warning and Danger callouts