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
1---
2name: prowler-docs
3description: >
4 Prowler documentation style guide and writing standards.
5 Trigger: When writing documentation for Prowler features, tutorials, or guides.
6license: Apache-2.0
7metadata:
8 author: prowler-cloud
9 version: "1.0"
10 scope: [root]
11 auto_invoke: "Writing documentation"
12allowed-tools: Read, Edit, Write, Glob, Grep, Bash, WebFetch, WebSearch, Task
13---
14
15## When to Use
16
17Use this skill when writing Prowler documentation for:
18- Feature documentation
19- API/SDK references
20- Tutorials and guides
21- Release notes
22
23## Brand Voice
24
25### Unbiased Communication
26- Avoid gendered pronouns (use "you/your" or "they/them")
27- Use inclusive alternatives: businessman → businessperson, mankind → humanity
28- No generalizations about gender, race, nationality, culture
29- Avoid militaristic language: fight → address, kill chain → cyberattack chain
30
31### Technical Terminology
32- Define key terms and acronyms on first use: "Identity and Access Management (IAM)"
33- Prefer verbal over nominal constructions: "The report was created" not "The creation of the report"
34- Use clear, accessible language; minimize jargon
35
36## Formatting Standards
37
38### Title Case Capitalization
39Use Title Case for all headers:
40- Good: "How to Configure Security Scanning"
41- Bad: "How to configure security scanning"
42
43### Hyphenation
44- Prenominal position: "world-leading company"
45- Postnominal position: "features built in"
46
47### Bullet Points
48Use when information can be logically divided:
49```markdown
50Prowler CLI includes:
51* **Industry standards:** CIS, NIST 800, NIST CSF
52* **Regulatory compliance:** RBI, FedRAMP, PCI-DSS
53* **Privacy frameworks:** GDPR, HIPAA, FFIEC
54```
55
56### Interaction Verbs
57- Desktop: Click, Double-click, Right-click, Drag, Scroll
58- Touch: Tap, Double-tap, Press and hold, Swipe, Pinch
59
60## SEO Optimization
61
62### Sentence Structure
63Place keywords at the beginning:
64- Good: "To create a custom role, open a terminal..."
65- Bad: "Open a terminal to create a custom role..."
66
67### Headers
68- H1: Primary (unique, descriptive)
69- H2-H6: Subheadings (logical hierarchy)
70- Include keywords naturally
71
72## MDX Components
73
74### Version Badge
75```mdx
76import { VersionBadge } from "/snippets/version-badge.mdx"
77
78## New Feature Name
79
80<VersionBadge version="4.5.0" />
81
82Description of the feature...
83```
84
85### Warnings and Danger Calls
86```mdx
87<Warning>
88Disabling encryption may expose sensitive data to unauthorized access.
89</Warning>
90
91<Danger>
92Running this command will **permanently delete all data**.
93</Danger>
94```
95
96## Prowler Features (Proper Nouns)
97
98Reference without articles:
99- Prowler App, Prowler CLI, Prowler SDK
100- Prowler Cloud, Prowler Studio, Prowler Registry
101- Built-in Compliance Checks
102- Multi-cloud Security Scanning
103- Autonomous Cloud Security Analyst (AI)
104
105## Documentation Structure
106
107```text
108docs/
109├── getting-started/
110├── tutorials/
111├── providers/
112│ ├── aws/
113│ ├── azure/
114│ ├── gcp/
115│ └── ...
116├── api/
117├── sdk/
118├── compliance/
119└── developer-guide/
120```
121
122## Resources
123
124- **Documentation**: See [references/](references/) for links to local developer guide
prowler-cloud