SuperAPI AI 工具集

documentation

写作与研究

查看项目

更新于 10-15 21:35

技能介绍

用途:用于增强代码文档、API 文档、README 与技术写作,覆盖代码注释、组件说明与项目说明文件。业务功能文档应改用 spec 技能。

主要能力:分四阶段执行——分析(在 .ai/workspace/analysis/[task-name].analysis.md 建立知识模型,发现 API、组件、结构与文档缺口)、计划(生成含优先级与大纲的文档计划)、批准门(必须获得用户明确批准后才可撰写)、执行(按反幻觉协议写作)。提供 README 结构模板,含 Features、Prerequisites、Installation、Configuration、Usage、Development、Testing、Deployment、Troubleshooting、Contributing、License 等章节。

使用方式:在 Codex 中以 $skill-name 调用;执行前须建立并同步任务跟踪,把工作拆成小任务并保留待办清单。撰写代码文档时需阅读 CLAUDE.md 获取代码模式示例,参考 .claude/docs/ 现有文档结构。项目引用按路由加载:docs/project-config.json、docs/project-reference/docs-index-reference.md、lessons.md 等,缺失或过期时先运行 $project-init 或窄范围设置路由;Codex 镜像或 AGENTS.md 缺失时请用户运行 $sync-codex。

限制与规则:未获计划批准不得开始写作;每条声明需 file:line 或来源证据,置信度高于 80% 才行动,低于 60% 不建议;禁止把猜测当事实。若必需步骤或工具在当前环境无法运行,须停止并询问用户。资料未提供具体收费、价格与平台支持信息。