prowler-docs
Prowler-docs provides the authoring standards and formatting conventions for creating consistent Prowler documentation. It covers brand voice principles, markdown formatting, SEO best practices, and MDX component usage across feature docs, tutorials, API references, and compliance guides.
Prowler-docs supplies the official writing standards and style conventions for authoring Prowler documentation.
AI-generated summary based on this skill's SKILL.md
Decision gist · record as of 2026-07-27
Prowler-docs supplies the official writing standards and style conventions for authoring Prowler documentation. Prowler-docs provides the authoring standards and formatting conventions for creating consistent Prowler documentation. It covers brand voice principles, markdown formatting, SEO best practices, and MDX component usage across feature docs, tutorials, API references, and compliance guides.
Use it when
- Prowler-docs specifies how to use MDX components and templates when creating feature documentation.
- Prowler-docs defines specific markdown formatting rules including header hierarchy structure, code block conventions, list formatting.
Verify before relying
Read SKILL.md below before installing (2 files). Open directory: indexed for reading, not audited.
Install
prowler-cloud/prowler/prowler-docs · repository language: Python
Open directory. Skills are indexed for reading, not audited. Review a skill's body before installing it.
Frequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
What are the prowler documentation style guide principles?
Prowler-docs establishes the official authoring standards for all Prowler documentation. The style guide covers brand voice principles emphasizing inclusive communication, markdown formatting conventions, proper header hierarchy for SEO optimization, and consistent structure across feature documentation, tutorials, API references, and compliance guides. Following these standards ensures documentation remains accessible, searchable, and aligned with Prowler's communication identity.
How do I write prowler docs using MDX components?
Prowler-docs specifies how to use MDX components and templates when creating feature documentation. The framework guides you through component selection, proper syntax, and integration patterns for different documentation types. MDX allows you to combine markdown with React components, enabling interactive examples and dynamic content within Prowler tutorials and guides while maintaining consistent formatting across the documentation site.
What formatting rules should I follow for prowler markdown docs?
Prowler-docs defines specific markdown formatting rules including header hierarchy structure, code block conventions, list formatting, and link syntax. Proper formatting ensures your documentation renders correctly, maintains SEO value through semantic HTML structure, and provides a consistent reading experience. The guide covers best practices for emphasis, tables, and inline code to keep Prowler docs professional and scannable.
How do I structure prowler tutorials and API references correctly?
Prowler-docs provides templates and structural guidelines for tutorials, API references, and compliance guides. Each documentation type has specific sections, ordering conventions, and content requirements. Tutorials follow a step-by-step format with clear objectives, while API references use consistent parameter documentation and example patterns. Compliance guides emphasize framework alignment and control mapping to ensure readers find information efficiently.
What is the prowler docs brand voice and inclusive language approach?
Prowler-docs establishes brand voice guidelines emphasizing clarity, accessibility, and inclusive communication. The standards guide writers to use plain language, avoid jargon where possible, employ gender-neutral pronouns, and ensure content serves diverse audiences. These principles apply across all documentation types, from technical API references to user-facing guides, creating welcoming and understandable Prowler documentation.
How does prowler documentation optimize for SEO?
Prowler-docs incorporates SEO best practices including proper header hierarchy, descriptive metadata, keyword placement, and semantic structure. The guidelines recommend using H1 for page titles, logical H2/H3 nesting, descriptive alt text for images, and internal linking strategies. These practices improve discoverability while maintaining readability, ensuring Prowler documentation ranks well in search results and serves users effectively.
SKILL.md
Rendered from the published skill. Quoted content, verbatim.
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
(truncated - see the full file via the links below)
File tree — 2 files
skills/prowler-docs/SKILL.md
skills/prowler-docs/references/documentation-docs.md
Let your AI agent find skills like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 56,283 agent skills by what they can do, searchable in plain language.
wish › “Write Prowler documentation following official style and formatting standards”
Give your agent the search over MCP, or paste the wish link into any chat. No install? Search from any chat →
Related skills
skill-sync maintains AGENTS.md auto-invoke sections by reading skill metadata and regenerating action-to-skill mappings. Run the sync script after creating or modifying skills to automatically update all affected AGENTS.md files across your repository scopes.
Prowler-changelog automates changelog management across UI, API, MCP Server, and SDK components using a fragment-based system that prevents merge conflicts on concurrent PRs. Each change gets its own fragment file under `changelog.d/` directories, which compile into versioned `CHANGELOG.md` files at release time. The skill enforces semantic versioning rules, validates fragment format, and requires explicit confirmation before any changelog edits.
This skill handles end-to-end compliance framework authoring, from choosing between universal (multi-provider, zero Python code) or legacy (single-provider, existing families) schemas to syncing with upstream sources, mapping checks to controls, and fixing JSON bugs. Use it when creating new frameworks, adding ConfigRequirements guardrails, auditing check mappings, or troubleshooting compliance output in the UI.
This skill drafts and executes git commits following the conventional-commits standard, enforcing structure with type, scope, and concise descriptions. It analyzes staged changes, presents a formatted message for review, and commits only after explicit user approval.
This skill audits Django migration files against PostgreSQL safety rules, catching common mistakes like bundling index creation with model definitions, mixing indexes across tables, and mishandling partitioned table indexes. It enforces separation of concerns—structural changes in one migration, performance indexes in another—and provides the two-step pattern required for partitioned tables to ensure indexes apply to all existing partitions without locking production data.
This skill equips you with battle-tested patterns for writing Prowler API tests, covering JSON:API request formatting, cross-tenant isolation via row-level security, role-based access control, and Celery task mocking. It includes a fixture dependency chain, response status code reference, and explicit rules for avoiding common pitfalls like TruffleHog false positives and incorrect content-type headers.
More skills prowler-compliance-review (Apache-2.0) · prowler-ci (Apache-2.0) · skill-creator (Apache-2.0) · prowler-test-sdk (Apache-2.0)