SuperAPI AI 工具集

prowler-docs

写作与研究

查看项目

更新于 10-16 04:35

技能介绍

用途:在撰写 Prowler 文档时提供统一的写作标准,适用于功能文档、API/SDK 参考、教程与指南、发布说明等场景。

主要能力:规范品牌语气,要求无偏见表达,避免性别化代词与泛化描述,使用包容性词汇,避免军事化用语;术语方面要求首次出现时定义关键术语与缩写,如 Identity and Access Management (IAM),优先动词化表达,减少行话。格式方面要求所有标题使用 Title Case,规定连字符在名词前与名词后的用法,并说明何时使用项目符号列表。交互动词区分桌面(Click、Double-click、Right-click、Drag、Scroll)与触屏(Tap、Double-tap、Press and hold、Swipe、Pinch)。SEO 方面要求关键词前置、标题层级 H1 唯一且描述性强、H2-H6 逻辑分层并自然融入关键词。

使用方式:文档中可使用 MDX 组件,如版本徽章 import { VersionBadge } from "/snippets/version-badge.mdx",以及 Warning 与 Danger 提示块。Prowler 功能名称作为专有名词不加冠词,如 Prowler App、Prowler CLI、Prowler SDK、Prowler Cloud、Prowler Studio、Prowler Registry。文档目录结构包含 getting-started、tutorials、providers(aws、azure、gcp 等)、api、sdk、compliance、developer-guide。

限制:资料未提供具体收费、价格、平台支持范围或效果数据;本地开发者指南链接位于 references/ 目录,具体内容暂未提供。