К основному содержанию
скилл CX Codex

prowler-docs — скилл для Claude Code: правила документации Prowler

Скилл prowler-docs для Claude Code задаёт стиль и структуру документации Prowler: голос бренда, Title Case, MDX-блоки и правила для терминов. Используется при написании гайдов и release notes.

Apache-2.0 ★ 15 302 обновлён 2026-10-25

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add prowler-cloud/prowler --skill prowler-docs -a claude-code
Открыть на GitHub

Что делает 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-code

2Вручную: положить файлы

~/.claude/skills/prowler-docs/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/prowler-docs/

По шагам, с командами для каждой платформы: Как установить скилл в 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

Похожие скиллы

Все скиллы по теме «Тексты и документация» →
docs-write metabase Скилл docs-write помогает писать и редактировать Markdown и MDX в стиле Metabase. Он пригодится для рабочих инструкций, описаний функций и другой документации. CX Codex +1 2 100установок docs-review metabase Скилл docs-review проверяет изменения в markdown-документации на соответствие стайлгайду Metabase и выдаёт нумерованный список замечаний. CX Codex +1 2 000установок docs-voice reactjs Скилл docs-voice задаёт правила голоса, тональности и оформления документации в стиле официального сайта React. Пригодится при написании руководств и справочников по библиотеке. CX Codex +1 ★ 11 851звёзд репо google-dev-docs surendranb Скилл google-dev-docs для Claude Code задаёт стиль Google для техдокументации: заголовки-действия, обращение на «вы», настоящее время, активный залог. Применяется при написании README, туториалов и справок по API. CX Codex +1 ★ 57звёзд репо write-docs tldraw Скилл write-docs для написания и обновления документации SDK tldraw. Помогает создавать статьи, обновлять существующие доки и следовать стилю проекта. CX Codex +1 491установок rspress-docs-generator rstackjs Скилл rspress-docs-generator разворачивает сайт документации на Rspress v2 или обновляет существующие страницы под изменения в коде, тестах и API. CX Codex +1 344установок

Из того же набора13

Весь набор →
tailwind-4 Скилл tailwind-4 для Claude Code помогает писать стили на Tailwind CSS 4. Он включается при работе с className, вариантами классов и динамическими значениями. CX Codex +1 617установок django-drf Скилл django-drf для быстрого создания REST API на Django с ViewSet'ами, сериализаторами и фильтрами по стандартам Prowler. Подключайте, когда пишете endpoints с RLS, JSON:API и OpenAPI документацией. CX Codex +1 484установок prowler-ci Скилл prowler-ci помогает разбираться с падениями проверок GitHub Actions и правилами пулл-реквестов в репозитории Prowler. CX Codex +1 ★ 15 302звёзд репо prowler-changelog Скилл prowler-changelog ведёт записи в CHANGELOG для компонентов Prowler через фрагменты changelog.d. Пригодится при подготовке PR и изменениях в UI, API, SDK или MCP Server. CX Codex +1 ★ 15 302звёзд репо prowler-compliance-review Скилл prowler-compliance-review проверяет пулреквесты с фреймворками комплаенса в репозитории Prowler. Находит синтаксические ошибки JSON, дубликаты ID и пропущенные проверки. CX Codex +1 ★ 15 302звёзд репо jsonapi Проверяет API-эндпоинты и ответы на соответствие JSON:API v1.1. Нужен при создании, изменении и ревью API. CX Codex +1 ★ 15 302звёзд репо prowler-compliance Скилл prowler-compliance ведёт compliance-фреймворки Prowler от создания JSON до синхронизации с каталогом-первоисточником и ревизии привязки чеков к требованиям. CX Codex +1 ★ 15 302звёзд репо prowler-test-ui Скилл prowler-test-ui задаёт правила E2E-тестирования интерфейса Prowler на Playwright. Пригодится при написании и правке тестов в каталоге ui/tests. CX Codex +1 ★ 15 302звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой