SuperAPI AI 工具集

document

办公与效率

查看项目

更新于 10-15 22:15

技能介绍

用途:创建或更新项目文档,包括 README 章节、架构文档、API 文档、示例、迁移说明、运维文档、运行手册和使用指南。输入可以是一个功能、行为、模块、命令、API、发布、操作流程或已有文档;优先使用显式输入,否则从上下文、近期改动、选中文件或分支推断。仅当读者、归属或位置不明确时才提问。

主要能力与工作流:先确定读者与目的(用户、集成方、贡献者、运维、维护者或未来智能体),再选择文档归属,优先更新最接近的现有文档,仅当读者、生命周期或归属明显不同时才新建。写作前阅读相关代码、测试、配置、脚本、schema 和现有文档以核实行为。按归属分离事实,避免产品行为、外部契约、仓库工作流和系统机制互相重复。保持文档可扫读、简洁、最新,避免会漂移的平行解释。示例从简,优先可运行命令、真实配置、经核对的片段,并链接到权威代码或测试。清理过时文档、失效链接、废弃示例和临时评审产物。尽可能校验链接、命令、片段、路径、生成输出及规范与文档的同步机制。

输出:更新后的文档、已识别的读者与文档归属、已核实的行为或契约、已执行的校验、仍存在的缺口或假设。

典型文档:README.md 写项目目的、安装、用法、常用命令和贡献说明;ARCHITECTURE.md 写稳定的系统机制、数据流、不变量和非显而易见的取舍;docs/features/.md 写预期产品行为、保证、边界情况和用户可见不变量;docs/api/.md 写外部或面向智能体的契约、认证、响应结构、错误和稳定性承诺;docs/development/*.md 写本地安装、测试、迁移、安全变更流程和操作步骤;TODO.md 与 CHANGELOG.md 分开维护未完成工作与已实现的可见变更。

限制与护栏:不得记录猜测行为,须对照源码核实或明确说明不确定性;公共模块和函数在输入、输出、副作用和失败模式不明显时应予记录;仅在读者、生命周期或归属不同时拆分文档;不维护重复的私有路由目录或未经验证的规范,代码、测试、schema 和生成产物通常是事实来源;临时笔记、审计和基线快照不应进入正式文档,除非成为持久决策或工作项;优先编辑和精简现有文档而非新增文件。具体安装命令与价格信息暂未提供。