SuperAPI AI 工具集

tasks-documentation

写作与研究

查看项目

更新于 10-15 21:35

技能介绍

用途:tasks-documentation 是 documentation 技能的自主子代理变体,适用于无需用户反馈循环的文档生成任务,覆盖代码注释、API 文档和架构文档的创建与更新。

主要能力:提供结构化模板,包括 C# XML 文档、TypeScript JSDoc、API 端点文档、README 结构与内联代码注释;支持识别文档类型并套用对应模式。

使用方式:执行前必须先阅读 .claude/skills/shared/evidence-based-reasoning-protocol.md;使用 TaskCreate 将全部工作拆分为小任务(包括每个文件读取任务),防止长文件导致上下文丢失;简单任务需询问用户是否跳过。工作流为:识别类型(代码注释、API 文档或架构文档)→ 套用模式 → 遵循准则。

准则:记录“为什么”而非“是什么”,包含示例,文档贴近代码,随代码变更更新;应记录公共 API、解释原因、提供用法示例;不应陈述显而易见内容、无限期保留 TODO、在文档中重复代码或创建易过时的独立文档。注释类型包括 /// <summary>(公共 API)、//(复杂逻辑)以及 TODO/FIXME/HACK/NOTE 标记。

适用场景:创建 API 文档、编写代码注释、更新 README、生成架构文档。

限制:该技能为自主变体,不适用于需要用户反馈的交互式文档任务(应改用 documentation);要求批判性思考与顺序思考,每项主张需可追溯证据。其他收费、平台与效果信息暂未提供。