Skip to main content
skill CX Codex

prowler-docs — Claude Code skill: Prowler docs style guide

prowler-docs sets the writing rules for Prowler documentation: brand voice, Title Case headings, MDX blocks, term handling. Useful when a tutorial or a release note has to match the project's style.

Apache-2.0 ★ 15,302 updated 2026-10-25

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add prowler-cloud/prowler --skill prowler-docs -a claude-code
Open on GitHub

What prowler-docs does

The skill activates when the agent writes Prowler docs: feature pages, API and SDK references, tutorials, release notes. What it holds is a rulebook for voice, terminology and layout.

Voice rules ban gendered pronouns and military metaphors, so kill chain becomes cyberattack chain, and they ask for wording like businessperson. Acronyms are expanded the first time they appear. Headings go in Title Case, hyphens in compound modifiers depend on position. For MDX there are ready pieces: VersionBadge, <Warning>, <Danger>. The guide also advises putting the keyword at the start of a sentence and lays out a docs/ tree with getting-started/, tutorials/, providers/, api/, sdk/, compliance/.

Prowler's own product names are written without an article, and that rule only makes sense inside this repo. The tool list is broad: Read, Edit, Write, Glob, Grep, Bash, WebFetch, WebSearch and Task, so the agent can edit a file and fetch a page in one run.

What it helps with

  • draft a feature page that matches Prowler's voice
  • convert a section's headings to Title Case
  • drop a version badge and a Warning block into an MDX page
  • strip gendered and militaristic wording from a draft
  • place new pages in the docs/ tree

Example prompts for the agent

  • Write the Prowler CLI page under docs/getting-started/ following the prowler-docs rules.
  • Add a version badge and a warning about disabling encryption to this guide.
  • Check the release notes draft: Title Case headings, acronyms expanded on first use.

How to install prowler-docs

1Skills CLI (Vercel)

npx skills add prowler-cloud/prowler --skill prowler-docs -a claude-code

2Manually: put the files in place

~/.claude/skills/prowler-docs/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/prowler-docs/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about prowler-docs

How to install prowler-docs in Claude Code?

Run npx skills add prowler-cloud/prowler --skill prowler-docs -a claude-code. The skill file lands at ~/.claude/skills/prowler-docs/SKILL.md.

What does prowler-docs do?

It hands the agent a rulebook for Prowler documentation: brand voice, terminology, Title Case headings, MDX components and the docs/ layout.

Which tools does the skill allow?

Read, Edit, Write, Glob, Grep, Bash, WebFetch, WebSearch and Task. That covers editing files and reading external pages.

Source text

SKILL.md · Apache-2.0
---
name: prowler-docs
description: >
  Prowler documentation style guide and writing standards.
  Trigger: When writing documentation for Prowler features, tutorials, or guides.
license: Apache-2.0
metadata:
  author: prowler-cloud
  version: "1.0"
  scope: [root]
  auto_invoke: "Writing documentation"
allowed-tools: Read, Edit, Write, Glob, Grep, Bash, WebFetch, WebSearch, Task
---

## When to Use

Use this skill when writing Prowler documentation for:
- Feature documentation
- API/SDK references
- Tutorials and guides
- Release notes

## Brand Voice

### Unbiased Communication
- Avoid gendered pronouns (use "you/your" or "they/them")
- Use inclusive alternatives: businessman → businessperson, mankind → humanity
- No generalizations about gender, race, nationality, culture
- Avoid militaristic language: fight → address, kill chain → cyberattack chain

### Technical Terminology
- Define key terms and acronyms on first use: "Identity and Access Management (IAM)"
- Prefer verbal over nominal constructions: "The report was created" not "The creation of the report"
- Use clear, accessible language; minimize jargon

## Formatting Standards

### Title Case Capitalization
Use Title Case for all headers:
- Good: "How to Configure Security Scanning"
- Bad: "How to configure security scanning"

### Hyphenation
- Prenominal position: "world-leading company"
- Postnominal position: "features built in"

### Bullet Points
Use when information can be logically divided:
```markdown
Prowler CLI includes:
* **Industry standards:** CIS, NIST 800, NIST CSF
* **Regulatory compliance:** RBI, FedRAMP, PCI-DSS
* **Privacy frameworks:** GDPR, HIPAA, FFIEC
```

### Interaction Verbs
- Desktop: Click, Double-click, Right-click, Drag, Scroll
- Touch: Tap, Double-tap, Press and hold, Swipe, Pinch

## SEO Optimization

### Sentence Structure
Place keywords at the beginning:
- Good: "To create a custom role, open a terminal..."
- Bad: "Open a terminal to create a custom role..."

### Headers
- H1: Primary (unique, descriptive)
- H2-H6: Subheadings (logical hierarchy)
- Include keywords naturally

## MDX Components

### Version Badge
```mdx
import { VersionBadge } from "/snippets/version-badge.mdx"

## New Feature Name

<VersionBadge version="4.5.0" />

Description of the feature...
```

### Warnings and Danger Calls
```mdx
<Warning>
Disabling encryption may expose sensitive data to unauthorized access.
</Warning>

<Danger>
Running this command will **permanently delete all data**.
</Danger>
```

## Prowler Features (Proper Nouns)

Reference without articles:
- Prowler App, Prowler CLI, Prowler SDK
- Prowler Cloud, Prowler Studio, Prowler Registry
- Built-in Compliance Checks
- Multi-cloud Security Scanning
- Autonomous Cloud Security Analyst (AI)

## Documentation Structure

```text
docs/
├── getting-started/
├── tutorials/
├── providers/
│   ├── aws/
│   ├── azure/
│   ├── gcp/
│   └── ...
├── api/
├── sdk/
├── compliance/
└── developer-guide/
```

## Resources

- **Documentation**: See [references/](references/) for links to local developer guide

© prowler-cloud · Apache-2.0 · prowler-cloud/prowler

Similar skills

All skills for Writing and docs →

From the same set13

The whole set →
tailwind-4 tailwind-4 is a Claude Code skill for styling with Tailwind CSS 4. It activates around className, variants, and dynamic values. CX Codex +1 617installs django-drf django-drf — a skill for building REST APIs on Django with ViewSets, serializers, and filters following Prowler standards. Use it when coding endpoints with RLS, JSON:API, and OpenAPI docs. CX Codex +1 484installs prowler-ci prowler-ci is a Claude Code skill that helps investigate GitHub Actions failures and PR validation gates in the Prowler repository. CX Codex +1 ★ 15,302repo stars prowler-changelog This skill manages Prowler changelog fragments for component changes and pull requests. It helps keep release notes in the required format. CX Codex +1 ★ 15,302repo stars prowler-compliance-review prowler-compliance-review reviews pull requests adding or updating compliance frameworks in Prowler. Validates JSON schemas, detects duplicate IDs, and flags missing checks. CX Codex +1 ★ 15,302repo stars jsonapi Checks API endpoints and responses against JSON:API v1.1. Use it when building, changing, or reviewing an API. CX Codex +1 ★ 15,302repo stars prowler-compliance Handles Prowler compliance frameworks end to end: authoring the JSON, syncing with the upstream catalog, and reviewing how checks map to requirements. CX Codex +1 ★ 15,302repo stars prowler-test-ui prowler-test-ui enforces Playwright E2E testing conventions for Prowler UI. Useful when building or editing tests inside ui/tests. CX Codex +1 ★ 15,302repo stars

Project sponsors

Companies that keep this analytics open