prowler-docs
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.zipInstalls 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.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
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
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:
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
import { VersionBadge } from "/snippets/version-badge.mdx"
## New Feature Name
<VersionBadge version="4.5.0" />
Description of the feature...
Warnings and Danger Calls
<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
docs/
├── getting-started/
├── tutorials/
├── providers/
│ ├── aws/
│ ├── azure/
│ ├── gcp/
│ └── ...
├── api/
├── sdk/
├── compliance/
└── developer-guide/
Resources
- Documentation: See references/ for links to local developer 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.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| prowler-docs (this skill) | 1 | 2mo | No flags | Beginner |
| docs-write | 22 | 6mo | No flags | Beginner |
| content-research-writer | 15 | 10mo | No flags | Beginner |
| doc-coauthoring | 16 | 8mo | No flags | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by prowler-cloud
View all by prowler-cloud →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.).
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.
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.
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.
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.
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/.