SuperAPI AI 工具集

sc-document

办公与效率

查看项目

更新于 10-16 01:10

技能介绍

用途:sc-document 是 tony363/superclaude 提供的文档生成技能,用于为代码、API 和功能生成聚焦的文档,适用于编写内联文档、API 参考、用户指南或技术说明。

主要能力:支持四种文档类型——inline(JSDoc/docstring、参数与返回值说明、函数级注释)、external(独立文档文件、组件概览、集成指南)、api(端点文档、请求/响应结构、用法示例)、guide(面向用户的教程、实现模式、常见用例)。风格可选 brief(简洁、仅必要信息、快速参考)或 detailed(全面解释、扩展示例、边界情况覆盖)。

使用方式:通过斜杠命令调用,例如 /sc:document src/auth/login.js --type inline、/sc:document src/api --type api --style detailed、/sc:document payment-module --type guide、/sc:document components/ --type external。--type 默认 inline,--style 默认 detailed。扩展标志包括 --pal-review(用 PAL 审查文档准确性)、--publish(通过 Rube 发布到 notion、confluence、gitbook)、--notify(通过 Rube 通知 slack、teams、email)。

行为流程:分析组件结构与功能,识别文档需求与受众,生成内容,套用一致格式,并确保与现有文档兼容。

集成:可配合 PAL MCP 做准确性审查、API 查询和写作辅助,配合 Rube MCP 做发布、通知和批量生成;工具层面使用 Read、Grep、Write、Glob。

限制:该技能不要求硬性证据,交付物为生成的文档文件、内联注释和 API 参考材料。资料未提供具体收费、价格、平台支持范围或效果保证等信息。