SuperAPI AI 工具集

technical-docs

写作与研究

查看项目

更新于 10-15 21:51

技能介绍

该技能用于 Sentry SDK 文档的撰写与审阅,尤其是 MDX 文件的创建、编辑和评审。核心原则包括:先讲“为什么”再讲“怎么做”,每节都说明开发者为何需要该功能;按用户意图而非 API 表面结构组织内容;避免重复示例,同一代码模式只展示一次并引用前文;精确说明何时、为何使用某方法;简洁面向读者,每概念一个示例,长节用 TL;DR 和要点列表;最佳实践应提供新信息而非重复。

Sentry 文档专属模式:用 <SplitLayout> 展示文字与代码并排,仅当代码直接说明文字且两者都需理解概念时使用;目录结构用普通代码块。用 <PlatformLink> 链接相关文档而非重复内容,如:For automatic tracing, see <PlatformLink to="/configuration/apis/">API Reference</PlatformLink>。展示文件相关代码时始终标注文件名。

审阅清单:每节是否先讲 WHY 再讲 HOW;同一代码模式是否重复出现(是则合并);开发者是否知道何时使用该方法;是否有可精简而不失原意的部分;最佳实践是否只是重复而非新增信息。