SuperAPI AI 工具集

document

办公与效率

查看项目

更新于 10-15 22:14

技能介绍

用途:根据代码库内容生成文档,三种规模——单个文件或模块的参考文档、跨多文件的端到端功能指南、覆盖整个项目的文档站点。适用于被要求“document this”等场景。

主要能力:静默扫描 package.json、目录结构、现有 docs 文件来识别技术栈与已有文档;识别导出、类型、依赖与引用关系;为开发者、用户或两者分别撰写内容;一次只问一个问题;先展示扫描发现再询问受众、格式、位置等决策;生成前先产出一节样例供确认深度与风格;文档中的代码示例必须来自真实源码,不得编造;全站模式下按大纲分批并行生成,最后做术语统一、交叉引用检查与缺口检查。

框架检测:可识别 Fumadocs、Nextra、Docusaurus、Starlight、VitePress,并按对应格式生成内容与侧边栏配置(如 meta.json、_meta.json、sidebars.js);未检测到框架时生成纯 Markdown 并给出建议。不会自动安装或脚手架搭建框架,搭建需走 /arc:implement。

使用方式:以 /arc:document 调用,可带文件路径或功能描述;无参数时会被询问要记录的范围。流程固定为:检测意图与上下文、范围与受众、框架检测、样例与校验、位置、生成、合并(仅全站)、支持文件。

限制与约束:禁用 EnterPlanMode 与 ExitPlanMode;交互须保持一次一问;本工作流需要完整的 Arc bundle,不能仅安装 prompts;技能内路径 agents/、references/、templates/ 等属于插件根目录,.ruler/、docs/、src/ 等指用户项目。生成内容而非搭建文档站应用。具体收费、价格、平台支持范围等资料暂未提供。