SuperAPI AI 工具集

add-documentation

写作与研究

查看项目

更新于 10-27 16:20

技能介绍

用途

add-documentation 用于为当前代码或功能添加完整文档,并遵循项目自身的文档标准。它依据 .cursor/rules/base/docs.mdc 与 .cursor/rules/base/readme.mdc 中的规则执行。

主要能力

该技能按文档层级决定写入位置:

  • apps/docu/content/docs/ 下的 MDX:用于架构说明、ADR、操作指南。当行为、架构、命令、约定或工作流发生变化时更新。
  • .cursor/rules:用于简短约束。当智能体不得违反的约定发生变化时更新。
  • 最近的 README:用于说明如何运行该应用或包,仅包含链接。当脚本、安装步骤或包用途发生变化时更新。
  • 行内注释:仅在代码本身容易引起误解时使用。

使用方式

技能描述中给出的流程为:

  1. 确定主题:先匹配已有文档章节,再匹配已有主题页;只有在没有合适页面时才新建页面。
  2. 如果规范性的解释发生变化,编写或修补 MDX。
  3. 仅在涉及运行、安装或脚本时修补 README,并链接到 MDX。
  4. 仅当约束发生变化时,修补 glob 匹配的 .mdc 文件。

同时要求:不要把 MDX 内容复制到规则或 README 中;不要 @-attach MDX。

适用场景

当用户输入特定触发内容(原始描述中为“Use when the user types…”)时使用,适用于代码或功能的行为、架构、命令、约定、工作流发生变化,需要同步更新文档的场合。

限制

资料未提供该技能的安装命令、收费方式、支持平台或具体效果等信息,暂未提供。