mcpField
P
prowler-docs

prowler-docs

github.com/prowler-cloud文档处理15.1k68 次安装今天更新
代码仓库

关于 prowler-docs

供 Prowler 文档撰写者使用的风格与结构参考，适用于功能指南、API 参考和发行说明。内容涵盖语气、术语、格式、MDX 组件与文档组织。

主要功能

  1. 01包容且中立的写作指导
  2. 02技术术语规范
  3. 03标题大小写与连字符规则
  4. 04MDX 警告和版本组件
  5. 05文档结构指导

适用场景

  1. 01撰写 Prowler 功能文档
  2. 02准备 API 或 SDK 参考
  3. 03编写教程、指南和发行说明

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/prowler-cloud/prowler --skill prowler-docs

安装后在 Claude Code 中输入/prowler-docs确认已加载。

附带文件references/documentation-docs.md

详细介绍

适用场景

在编写 Prowler 文档时，适用于：

  • 功能文档
  • API/SDK 参考
  • 教程和指南
  • 发布说明

品牌语调

公正的沟通方式
  • 避免使用带有性别倾向的人称代词（使用“你/你的”或“他们”）
  • 使用包容性替代表达：businessman → businessperson，mankind → humanity
  • 不要对性别、种族、国籍和文化进行概括
  • 避免使用军事化措辞：fight → address，kill chain → cyberattack chain
技术术语
  • 首次使用时定义关键术语和缩略词：“Identity and Access Management（IAM）”
  • 优先使用动词表达，而非名词化结构：“The report was created”，而不是“The creation of the report”
  • 使用清晰易懂的语言；尽量减少术语

格式规范

标题大小写

所有标题使用 Title Case：

  • 正确：“How to Configure Security Scanning”
  • 错误：“How to configure security scanning”
连字符用法
  • 前置修饰语位置：“world-leading company”
  • 后置修饰语位置：“features built in”
项目符号

信息可按逻辑划分时，使用项目符号：

Prowler CLI includes:
* **Industry standards:** CIS, NIST 800, NIST CSF
* **Regulatory compliance:** RBI, FedRAMP, PCI-DSS
* **Privacy frameworks:** GDPR, HIPAA, FFIEC
交互动词
  • 桌面端：Click、Double-click、Right-click、Drag、Scroll
  • 触屏端：Tap、Double-tap、Press and hold、Swipe、Pinch

SEO 优化

句子结构

将关键词放在句首：

  • 正确：“To create a custom role, open a terminal...”
  • 错误：“Open a terminal to create a custom role...”
标题
  • H1：主要标题（独特且具有描述性）
  • H2-H6：子标题（层级清晰）
  • 自然地包含关键词

MDX 组件

版本徽章
import { VersionBadge } from "/snippets/version-badge.mdx"

## New Feature Name

<VersionBadge version="4.5.0" />

Description of the feature...
警告和危险提示
<Warning>
Disabling encryption may expose sensitive data to unauthorized access.
</Warning>

<Danger>
Running this command will **permanently delete all data**.
</Danger>

Prowler 功能（专有名词）

提及以下名称时不加冠词：

  • 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）

文档结构

docs/
├── getting-started/
├── tutorials/
├── providers/
│   ├── aws/
│   ├── azure/
│   ├── gcp/
│   └── ...
├── api/
├── sdk/
├── compliance/
└── developer-guide/

资源

  • 文档：参阅 references/，获取本地开发指南的链接

评论

支持 Markdown