SuperAPI AI 工具集

update-Codex-documentation

写作与研究

查看项目

更新于 10-16 05:45

技能介绍

用途:在项目发生重大变更(新增或移除功能、架构或设计模式调整、依赖与技术栈更新、API 端点或数据库结构变化、目录重构、开发流程变化)后,系统性更新项目文档,保持各文档一致、准确。每次工作会话结束时为强制更新场景,用户说“update project documentation”“update docs”或“close for the day”时触发。

主要能力:按“具体到一般”的顺序更新文档,先技术规格(docs/API.md、docs/DATABASE.md),再架构(ARCHITECTURE.md、TECH_STACK.md),再 AI 指令(AGENTS.md),再用户指南(README.md),最后概览(PROJECT_BRIEF.md)与优先级路线图(docs/plans/NEXT_FEATURES.md)。会话结束流程包括:创建完成文档 docs/plans/YYYY-MM-DD-[feature-name]-completion.md、更新 docs/plans/INDEX.md、更新 docs/plans/NEXT_FEATURES.md、更新 MEMORY.md,可选生成当日总结。

使用方式:先读 SKILL.md,再按需加载 references/ 下的深入文件;按清单逐文件更新主章节、相关章节、示例代码,破坏性变更需加迁移说明;随后做一致性检查(术语、版本号、文件路径、组件名、功能描述)。文档规范为强制项:所有 .md 文件不超过 500 行,采用高层目录文档加深入主题文档的两层结构;AGENTS.md 控制在 10k 字符以内,作为导航枢纽链接到 docs/ 子目录;新增文档统一放在 docs/ 的语义子目录下,根 README.md 只指向 docs/。

适用场景:功能增删、架构变更、技术栈更新、API 或数据库变更、目录重构、开发流程调整,以及每日收尾。

限制:不适用于拼写修正、代码注释、尚未合并的进行中功能;文档需反映 Windows 开发、Ubuntu 预发、Debian 生产(均为 MySQL 8.x)三环境部署,更新 AGENTS.md 或 TECH_STACK.md 时须包含部署环境表与跨平台规则。资料未提供具体安装命令、收费与价格信息。