SuperAPI AI 工具集

llmdocs

智能体与模型

查看项目

更新于 10-15 23:32

技能介绍

用途:在完成重要开发工作后同步项目文档,避免文档与代码脱节。它维护两类文件:CLAUDE.md 提供简洁的项目/目录概览,始终加载;.llmdocs/ 存放按概念拆分的详细设计文档,按需加载。

主要能力:自动查找项目中所有 CLAUDE.md 与 .llmdocs/ 目录并逐层更新,注意子目录层级与限界上下文,不跨层泄漏概念;结合对话历史、git 提交、暂存、未暂存与未跟踪改动判断哪些文档受影响,并提出更新计划、经用户确认后写入。.llmdocs/ 默认包含 architecture.md、api.md、data-model.md、deployment.md、ops.md、security.md 六个必选文件,其余按需新增。

使用方式:在每个文档目录层级按脚本计算基线并对比改动(无自身提交时回退到根提交),先用 --stat 判断规模,过大则直接读取变更文件;未跟踪文件不在 diff 中,需直接读取。文档为当前状态规范,不记录变更或决策历史。CLAUDE.md 目标 500 行以内,包含名称、用途、技术栈、架构、命令、约定、关键概念与 Docs 引用列表;.llmdocs/ 每文件不超过 500 行,使用标题、表格、代码块而非段落。

限制:准确性优先于覆盖度,只记录可从代码验证的内容;不要删除既有内容,需先询问;文档无变化时应说明并跳过。