Prowler Documentation Style Guide
FreeStandardize your Prowler documentation effortlessly.
Free · Opens the source repo
What Prowler Documentation Style Guide does
The Prowler Documentation Style Guide provides a comprehensive set of standards for writing documentation related to Prowler features, tutorials, and guides. This skill is designed specifically for developers and technical writers who need to create clear and consistent documentation that adheres to best practices in technical communication. By following this guide, users can ensure that their documentation is not only informative but also accessible to a diverse audience.
The guide emphasizes unbiased communication, encouraging the use of inclusive language and avoiding gendered pronouns. It also provides clear guidelines on technical terminology, ensuring that key terms and acronyms are defined upon first use. This approach minimizes jargon and promotes clarity, making it easier for readers to understand complex concepts. Additionally, the formatting standards outlined in the guide help maintain a professional appearance throughout the documentation, with specific rules for title case capitalization, hyphenation, and the use of bullet points.
For SEO optimization, the skill advises on effective sentence structure and header organization, ensuring that keywords are strategically placed to enhance discoverability. The inclusion of MDX components, such as version badges and warning calls, further enriches the documentation, providing readers with critical information in a visually distinct manner. Overall, this skill is essential for anyone involved in creating Prowler-related documentation, as it streamlines the writing process and enhances the quality of the final product.
When to use it
Use this skill when creating feature documentation, API references, tutorials, or release notes for Prowler.
When not to use it
This skill may not be suitable for documentation unrelated to Prowler or for informal writing styles.
What you can build with it
Creating API References
Use this skill to ensure your API documentation is clear, consistent, and follows best practices.
Writing Tutorials
When crafting tutorials for Prowler, this guide helps maintain a professional tone and structure.
Standardizing Release Notes
Ensure your release notes are formatted correctly and communicate changes effectively using this style guide.
How to install Prowler Documentation Style Guide
View source1. Install with the skills CLI
npx skills add prowler-cloud/prowler/prowler-docs --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by prowler-cloudWhen 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
Frequently asked questions about Prowler Documentation Style Guide
Similar skills
Supabase Docs Authoring
Streamline your Supabase documentation process.
Docs Writer
Streamline your documentation process with precision.
Clinical Case Report
Generate structured medical case presentations.
CrossFrame Suite
Streamline complex workflows for Chinese structural analysis.
Em Dash Expert
Master the em dash for clear, precise writing.
Nature Statistics Reporting
Enhance manuscript statistics for high-impact journal submissions.