Back to Details

prowler-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

When to Use

适用场景

Use this skill when writing Prowler documentation for:
  • Feature documentation
  • API/SDK references
  • Tutorials and guides
  • Release notes
在为以下内容撰写Prowler文档时使用本指南：
  • 功能文档
  • API/SDK参考文档
  • 教程与指南
  • 发布说明

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
  • 避免使用性别指代代词（使用“你/您”或“他们/她们”）
  • 使用包容性替代表述：businessman → businessperson，mankind → humanity
  • 不对性别、种族、国籍、文化进行笼统概括
  • 避免使用军事化用语：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
  • 首次使用关键术语和缩写时需定义：“身份与访问管理（IAM）”
  • 优先使用动词性结构而非名词性结构：用“生成了报告”而非“报告的生成”
  • 使用清晰易懂的语言，尽量减少行话

Formatting Standards

格式标准

Title Case Capitalization

标题大小写规则

Use Title Case for all headers:
  • Good: "How to Configure Security Scanning"
  • Bad: "How to configure security scanning"
所有标题采用标题大小写格式：
  • 正确示例："How to Configure Security Scanning"
  • 错误示例："How to configure security scanning"

Hyphenation

连字符使用规则

  • Prenominal position: "world-leading company"
  • Postnominal position: "features built in"
  • 前置定语位置："world-leading company"
  • 后置定语位置："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
当信息可按逻辑划分时使用：
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
  • 桌面端：Click（单击）、Double-click（双击）、Right-click（右键单击）、Drag（拖拽）、Scroll（滚动）
  • 触控端：Tap（轻触）、Double-tap（双击）、Press and hold（长按）、Swipe（滑动）、Pinch（捏合）

SEO Optimization

SEO优化

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..."
将关键词置于句首：
  • 正确示例："To create a custom role, open a terminal..."
  • 错误示例："Open a terminal to create a custom role..."

Headers

标题层级

  • H1: Primary (unique, descriptive)
  • H2-H6: Subheadings (logical hierarchy)
  • Include keywords naturally
  • H1：主标题（唯一、具有描述性）
  • H2-H6：子标题（逻辑层级清晰）
  • 自然融入关键词

MDX Components

MDX组件

Version Badge

版本徽章

mdx
import { VersionBadge } from "/snippets/version-badge.mdx"
mdx
import { VersionBadge } from "/snippets/version-badge.mdx"

New Feature Name

New Feature Name

<VersionBadge version="4.5.0" />
Description of the feature...
undefined
<VersionBadge version="4.5.0" />
Description of the feature...
undefined

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>
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)

Prowler专有名词规范

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)
提及专有名词时无需加冠词：
  • Prowler App、Prowler CLI、Prowler SDK
  • Prowler Cloud、Prowler Studio、Prowler Registry
  • 内置合规检查（Built-in Compliance Checks）
  • 多云安全扫描（Multi-cloud Security Scanning）
  • 自主云安全分析师（AI）（Autonomous Cloud Security Analyst (AI)）

Documentation Structure

文档结构

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

Resources

参考资源

  • Documentation: See references/ for links to local developer guide
  • 文档：查看references/获取本地开发者指南的链接