prowler-docs

Define Prowler documentation standards for features, tutorials, and API references.

14.6k|2.3k|Updated Aug 24, 2016
One-click install
npx skills add https://github.com/prowler-cloud/prowler --skill prowler-docs-prowler-cloud
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: prowler-docs
Source: https://github.com/prowler-cloud/prowler/tree/main/skills/prowler-docs
Command: npx skills add https://github.com/prowler-cloud/prowler --skill prowler-docs-prowler-cloud

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Prowler documentation style guide ensures consistent voice, structure, and quality across features, tutorials, and guides by standardizing terminology, formatting, and templates.

Core Features & Use Cases

  • Establishes brand voice, inclusive language, and concise terminology for all Prowler docs.
  • Defines formatting rules, header hierarchies, hyphenation, bullet styles, and MDX component usage to maintain consistency.
  • Provides SEO guidance and a documented structure for developer guides, APIs, and release notes.

Quick Start

Apply the Prowler documentation style guide to any new feature, tutorial, or API guide to ensure consistent voice, formatting, and structure.

Frequently Asked Questions about prowler-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are standard documentation guidelines for writing MDX feature tutorials?

Documentation guidelines for MDX feature tutorials specify frontmatter requirements, header hierarchies, and formatting rules to maintain consistent voice, structure, and quality across technical docs.

How do I ensure consistent formatting and SEO across API reference documentation?

Apply standardized writing guidelines to ensure consistent formatting and SEO across API reference documentation by defining keyword usage, MDX components, and structural templates for developer guides.

Does a documentation style guide help with writing release notes and developer guides?

Yes, a documentation style guide helps with writing release notes and developer guides by providing documented structure, standard terminology, and brand voice rules to ensure uniform quality.

How to organize documentation resources and frontmatter for technical writing standards?

Organize documentation resources and frontmatter for technical writing standards by following a centralized style guide that specifies resource organization rules, required metadata fields, and formatting constraints.

What is the best way to maintain standard terminology and inclusive language in technical docs?

The best way to maintain standard terminology and inclusive language in technical docs is to enforce a style guide that explicitly defines concise terminology, brand voice, and acceptable wording conventions.