SuperAPI AI 工具集

document-writer

写作与研究

查看项目

更新于 10-15 20:05

技能介绍

用途:为指定目标项目编写或更新技术文档,覆盖 README/概览、API 参考、架构或设计说明、用户与运维指南、故障排查与 FAQ、CONTRIBUTING/迁移/发布说明、JSDoc 与代码注释等类型。

主要能力:先对任务分类,再从代码库取证——读现有文档以保留项目术语,检查目录结构、入口、配置、公共接口、示例与测试,追踪关键流程;核对路由、配置键、环境变量与默认值;写注释前先读具体符号实现。随后决定语言、受众与输出位置,套用对应模板并控制篇幅,多组件架构文档可含 Mermaid 图。

使用方式:以目标路径与文档任务作为 $ARGUMENTS 传入,例如 './docs/api.md update the payment API docs' 或 './src/utils.ts add JSDoc for the public helpers';为空则报错提示。动笔前需读 <skill-dir>/references/WORKFLOW.md、DOCUMENT_TYPES.md、VERIFICATION_CHECKLIST.md;若请求为中文、输出文件为中文或要求改写为中文,还需读 CHINESE_TECH_WRITING.md。优先就地更新指定文件,未指定时按惯例放于仓库根(README.md、CONTRIBUTING.md、MIGRATION.md)、docs/ 或源文件;仍不明确则提一个聚焦问题。

限制:不得编造 API、CLI 参数、配置默认值、性能数据或实现细节;不照抄已过时的旧文档;不生成仅复述代码的模板化注释;不得泄露密钥、令牌、私有端点或内部说明。无法从仓库得出且必要的事实用 TODO: 标注。输出仅为文档成品,除非用户明确要求,不附加额外对话解释。