SuperAPI AI 工具集

managing-documentation

写作与研究

查看项目

更新于 10-16 08:34

技能介绍

用途:该技能集合用于项目文档的撰写与评审,可处理 Markdown 文档、技能文件(SKILL.md)、规则文件、AGENTS.md 及类似说明性内容,也用于在合并或发布前对文档做质量审查。使用环境为代理可读写仓库文件的任意环境。

主要能力:提供两类文档配方,按用户意图选择其一。创建类对应 creating-documentation.md,涵盖新增或更新文档、模板优先的工作流、风格与格式、技能与规则约定;评审类对应 reviewing-documentation.md,提供只读评审,依据 creating-documentation 的标准给出检查清单与结构化反馈。

使用方式:先判断用户意图,只读取一条对应配方,不要在用户未切换意图时加载其他配方文件。创建意图(如“为……写文档”“起草一个技能”“更新 README 中……部分”)读取 creating-documentation.md;评审意图(如“评审这份文档”“写得是否清楚”“文档 PR 反馈”)读取 reviewing-documentation.md。无论用户是否 @ 提及该技能,只要意图匹配即适用。

示例:用户要求记录新 API 端点时,走创建配方,若无模板先给出大纲,再起草简洁参考,路径与命令用反引号标注。用户粘贴技能草稿询问可读性时,走评审配方,运行检查清单,输出 Summary / Strengths / Issues / Suggested next steps。用户给出文档 PR 差异时,走评审配方,评审变更部分并与上下文保持一致性,除非用户要求全文检查。

限制:资料未提供更详细的配置、安装命令、平台支持与收费信息。