prowler-docs
SolidProwler documentation style guide and writing standards. Trigger: When writing documentation for Prowler features, tutorials, or guides.
AI & Automation 2,279 stars
168 forks Updated 3 weeks ago Apache-2.0
Install
Quality Score: 97/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
Skill Content
## 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:
```markdown
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: "T...
Details
- Author
- foryourhealth111-pixel
- Repository
- foryourhealth111-pixel/Vibe-Skills
- Created
- 3 months ago
- Last Updated
- 3 weeks ago
- Language
- Python
- License
- Apache-2.0
Similar Skills
Semantically similar based on skill content — not just same category
AI & Automation Solid
docs-style
Core technical documentation writing principles for voice, tone, structure, and LLM-friendly patterns. Use when writing or reviewing any documentation.
63 Updated 2 days ago
existential-birds AI & Automation Solid
doc-generator
Generate or remediate documentation with human-quality writing and style
308 Updated today
athola AI & Automation Listed
prj-docs
Generate and maintain this marketplace's Pagesmith documentation. Use when updating docs/, regenerating reference pages, adding Pagesmith navigation meta, polishing the home page, or documenting marketplace plugins, skills, agents, MCP servers, and helper binaries.
0 Updated 1 weeks ago
sujeet-pro