Maintains Prowler's documentation standards for clarity and inclusive language.

Install

mkdir -p .claude/skills/prowler-docs && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/6815" && unzip -o skill.zip -d .claude/skills/prowler-docs && rm skill.zip

Installs to .claude/skills/prowler-docs

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

Prowler documentation style guide and writing standards. Trigger: When writing documentation for Prowler features, tutorials, or guides.
136 chars · catalog description✓ has a “when” trigger
Beginner

Key capabilities

  • →Apply Prowler-specific writing standards
  • →Ensure inclusive language in documentation
  • →Define technical terms and acronyms
  • →Format headers with Title Case
  • →Optimize content for search engines
  • →Structure documentation consistently

How it works

This skill provides a style guide and writing standards for Prowler documentation, covering brand voice, formatting, and SEO. It ensures consistency across different documentation types.

Inputs & outputs

You give it
Prowler documentation content (features, tutorials, guides, release notes)
You get back
Formatted Prowler documentation adhering to style guidelines

When to use prowler-docs

  • →Drafting Prowler feature documentation
  • →Writing technical tutorials and guides
  • →Standardizing API reference formatting
  • →Updating project release notes

About this skill

Source of Truth

docs/AGENTS.md is the full style guide (brand voice, capitalization, hyphenation, bullets, quotation marks, headers, Version Badge, AppliesTo, cloud marker, warnings). Read the relevant section before writing; this skill is the short version plus the Mintlify mechanics.

Critical Rules

  • Product names (proper nouns, no articles): Prowler Cloud, Prowler Private Cloud, Prowler Hub, Prowler Lighthouse AI, Prowler MCP, Prowler CLI, Prowler Local Server, Prowler Local Dashboard, Prowler SDK.
  • NEVER use the former names "Prowler App" (now Prowler Local Server) or "Prowler Enterprise" (now Prowler Private Cloud) in new writing. Only getting-started/products/index.mdx and the site banner document the mapping. Existing URLs such as user-guide/tutorials/prowler-app-* keep their paths; the rule applies to prose.
  • Web UI guides are written for Prowler Cloud: steps link to https://cloud.prowler.com/sign-in; state the scope once with <AppliesTo />; mention Prowler Local Server inline only where behavior differs.
  • Every new page goes in docs/docs.json navigation (path without .mdx). Renamed or moved pages need an entry in redirects ({"source": "/old/path", "destination": "/new/path"}).
  • Title Case for headers; American English; define acronyms on first use ("AWS Identity and Access Management (IAM)").
  • Avoid second person except in imperative instructions; prefer verbal over nominal constructions; no gendered or militaristic language (fight -> address, attacker -> threat actor, kill chain -> cyberattack chain).
  • Goal first for SEO: "To create a custom role, open a terminal..." not "Open a terminal to create a custom role...".
  • UI elements, buttons and exact input go in double quotes: Click "Save". Use Click/Double-click/Right-click (desktop) and Tap/Press and hold/Swipe (touch).

Page Skeleton

---
title: 'Configuring Mute Rules in Prowler Cloud'
---

import { VersionBadge } from "/snippets/version-badge.mdx"
import { AppliesTo } from "/snippets/applies-to.mdx"

<VersionBadge version="5.48.0" />

<AppliesTo />

To mute findings in bulk, ...

## Creating a Mute Rule

MDX Components and Snippets (docs/snippets/)

Snippet / componentUse
<VersionBadge version="X.Y.Z" /> (version-badge.mdx)Feature, flag, endpoint, check or framework introduced in a version. Own line under the header, no v prefix
<AppliesTo /> (applies-to.mdx)Web UI guide valid for several products. Default: Prowler Cloud, Prowler Private Cloud, Prowler Local Server; narrow with products={["Prowler Cloud", "Prowler Private Cloud"]}. Below the Version Badge; on provider getting-started pages, under ## Prowler Cloud
<SubscriptionBanner /> (subscription-banner.mdx)Feature only in Prowler Cloud / Private Cloud. Do not combine with AppliesTo
provider-cards.mdxGENERATED: run python3 docs/scripts/generate_provider_cards.py (prek hook + CI check) when editing docs/user-guide/providers/**/getting-started-*.mdx
<Note>, <Warning>, <Danger> (Mintlify)Low/moderate/high severity. Say the consequence ("Disabling encryption may expose sensitive data"), not just "avoid X". Use notes sparingly
<Steps>/<Step title="...">, <Tabs>/<Tab> (Mintlify)Procedures and per-option content

Subscription-gated pages also get the cloud marker in docs/style.css (see "Cloud Marker for Subscription Content" in docs/AGENTS.md).

Documentation Structure

docs/
├── docs.json            # Mintlify config: tabs, groups, pages, redirects
├── AGENTS.md            # Full style guide
├── introduction.mdx
├── getting-started/     # products/, installation/, basic-usage/, comparison/, goto/
├── user-guide/          # tutorials/, providers/<provider>/, cli/, compliance/, cookbooks/, ai-agents/
├── developer-guide/     # checks, services, provider, compliance, outputs, ai-skills, ...
├── security/
├── snippets/            # Reusable MDX components (see table)
├── scripts/             # generate_provider_cards.py
├── images/, img/
├── changelog.mdx, support.mdx, troubleshooting.mdx
└── style.css

Navigation tabs in docs.json: Getting Started, Guides, Developer Guide, Security, Support, Troubleshooting, Changelog, About Us.

Commands

npm install --global [email protected]   # version pinned in docs/README.md
cd docs && mint dev                 # preview at http://localhost:3000
cd docs && mint broken-links        # check internal links
python3 docs/scripts/generate_provider_cards.py   # regenerate provider cards snippet

Docs-only PRs (docs/**) need no changelog fragment; the PR title type is docs:.

Resources

  • Style guide: docs/AGENTS.md
  • Documentation: See references/ for the local contributor guide

How it compares

This skill offers specific guidelines for Prowler documentation, ensuring brand consistency and technical accuracy, unlike general writing style guides.

Compared to similar skills

prowler-docs side by side with the closest alternatives in the catalog.

SkillInstallsUpdatedSafetyDifficulty
prowler-docs (this skill)15moNo flagsBeginner
docs-write229moNo flagsBeginner
content-research-writer151yNo flagsBeginner
doc-coauthoring1611moNo flagsBeginner

Try saying

Example prompts that trigger this skill in your AI assistant.

You might also like

docs-write

metabase

Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).

22139

content-research-writer

ComposioHQ

Assists in writing high-quality content by conducting research, adding citations, improving hooks, iterating on outlines, and providing real-time feedback on each section. Transforms your writing process from solo effort to collaborative partnership.

15111

doc-coauthoring

anthropics

Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.

1686

research-grants

davila7

Write competitive research proposals for NSF, NIH, DOE, and DARPA. Agency-specific formatting, review criteria, budget preparation, broader impacts, significance statements, innovation narratives, and compliance with submission requirements.

694

teams-channel-post-writer

daymade

Creates educational Teams channel posts for internal knowledge sharing about Claude Code features, tools, and best practices. Applies when writing posts, announcements, or documentation to teach colleagues effective Claude Code usage, announce new features, share productivity tips, or document lessons learned. Provides templates, writing guidelines, and structured approaches emphasizing concrete examples, underlying principles, and connections to best practices like context engineering. Activates for content involving Teams posts, channel announcements, feature documentation, or tip sharing.

591

write-docs

tldraw

Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.

665

Search skills

Search the agent skills registry