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