prowler-docs — скилл для Claude Code: правила документации Prowler
Скилл prowler-docs для Claude Code задаёт стиль и структуру документации Prowler: голос бренда, Title Case, MDX-блоки и правила для терминов. Используется при написании гайдов и release notes.
Apache-2.0 ★ 15 302 обновлён 2026-10-25
npx skills add prowler-cloud/prowler --skill prowler-docs -a claude-codeЧто делает prowler-docs
Скилл подключается, когда агент берётся за документацию Prowler: страницы фич, справочники по API и SDK, туториалы, release notes. Внутри свод правил по голосу бренда, терминам и вёрстке.
Голос: без гендерных местоимений, с инклюзивными заменами (businessman → businessperson) и без военной лексики: kill chain становится cyberattack chain. Аббревиатуры расшифровываются при первом упоминании, заголовки идут в Title Case, дефисы в составных определениях ставятся по позиции. Для MDX есть готовые куски: VersionBadge, <Warning>, <Danger>. Плюс совет ставить ключевое слово в начало фразы и дерево docs/ с разделами getting-started/, tutorials/, providers/, api/, sdk/, compliance/.
Правила про собственные имена и структуру docs/ привязаны к репозиторию Prowler: в стороннем проекте свод не подойдёт как есть. Агент получает Read, Edit, Write, Glob, Grep, Bash, WebFetch, WebSearch и Task, поэтому может и файл поправить, и внешнюю страницу подтянуть.
Какие задачи решает
- написать страницу про новую фичу в стиле Prowler
- привести заголовки раздела к Title Case
- вставить бейдж версии и блок Warning в MDX-страницу
- убрать из черновика gendered-местоимения и военную лексику
- разложить новые материалы по дереву
docs/
Примеры запросов агенту
- Напиши страницу про Prowler CLI в
docs/getting-started/по правилам скилла prowler-docs. - Добавь в этот гайд бейдж версии 4.5.0 и предупреждение про отключение шифрования.
- Проверь черновик release notes: Title Case в заголовках, аббревиатуры расшифрованы при первом упоминании.
Как установить prowler-docs
1Через Skills CLI (Vercel)
npx skills add prowler-cloud/prowler --skill prowler-docs -a claude-code2Вручную: положить файлы
~/.claude/skills/prowler-docs/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/prowler-docs/
1Через Skills CLI (Vercel)
npx skills add prowler-cloud/prowler --skill prowler-docs -a codex2Вручную: положить файлы
.agents/skills/prowler-docs/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add prowler-cloud/prowler --skill prowler-docs -a cursor2Вручную: положить файлы
.cursor/skills/prowler-docs/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install prowler-cloud/prowler skills/prowler-docs2Вручную: положить файлы
.github/skills/prowler-docs/SKILL.md1Через Skills CLI (Vercel)
npx skills add prowler-cloud/prowler --skill prowler-docs -a gemini-cli2Командой платформы
gemini skills install https://github.com/prowler-cloud/prowler --path skills/prowler-docsВручную: положить файлы
.devin/skills/prowler-docs/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add prowler-cloud/prowler --skill prowler-docs -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о prowler-docs
Как установить prowler-docs в Claude Code?
Выполните npx skills add prowler-cloud/prowler --skill prowler-docs -a claude-code. Файл скилла появится в ~/.claude/skills/prowler-docs/SKILL.md.
Что делает prowler-docs?
Это свод правил для документации Prowler: голос бренда, работа с терминами, Title Case в заголовках, MDX-компоненты и раскладка страниц по docs/.
Какие инструменты получает агент вместе со скиллом?
Read, Edit, Write, Glob, Grep, Bash, WebFetch, WebSearch и Task. Этого хватает, чтобы править файлы и смотреть внешние страницы.
Исходный текст
SKILL.md · Apache-2.0
---
name: prowler-docs
description: >
Prowler documentation style guide and writing standards.
Trigger: When writing documentation for Prowler features, tutorials, or guides.
license: Apache-2.0
metadata:
author: prowler-cloud
version: "1.0"
scope: [root]
auto_invoke: "Writing documentation"
allowed-tools: Read, Edit, Write, Glob, Grep, Bash, WebFetch, WebSearch, Task
---
## 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: "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
```mdx
import { VersionBadge } from "/snippets/version-badge.mdx"
## New Feature Name
<VersionBadge version="4.5.0" />
Description of the feature...
```
### Warnings and Danger Calls
```mdx
<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
```text
docs/
├── getting-started/
├── tutorials/
├── providers/
│ ├── aws/
│ ├── azure/
│ ├── gcp/
│ └── ...
├── api/
├── sdk/
├── compliance/
└── developer-guide/
```
## Resources
- **Documentation**: See [references/](references/) for links to local developer guide
© prowler-cloud · Apache-2.0 · prowler-cloud/prowler