SuperAPI AI 工具集

add-documentation

写作与研究

查看项目

更新于 10-16 06:17

技能介绍

用途:为当前代码或功能补充文档,遵循项目既有规范文件 .cursor/rules/base/docs.mdc 与 .cursor/rules/base/readme.mdc。

写入位置与适用时机:apps/docu/content/docs/ 下的 MDX 用于架构、ADR 与操作指南,当行为、架构、命令、约定或工作流变化时更新;.cursor/rules 下的 .mdc 记录简短约束,当有一条智能体不得违反的约定变化时更新;最近的 README 说明如何运行该应用或包并只放链接,当脚本、初始化或包用途变化时更新;仅当代码本身易产生误导时写内联注释。

使用方式:先确定主题——匹配已有文档章节,其次复用已有主题页,只有在没有合适页面时才新建页面;若权威说明发生变化,编写或修补对应 MDX;README 只在运行、初始化或脚本相关时修补,并链接到 MDX;仅当约束变化时,修补由 glob 匹配到的 .mdc。

限制:不要把 MDX 内容复制进规则或 README,不要以 @ 方式附加 MDX。其余功能、收费、平台与效果信息暂未提供。