SuperAPI AI 工具集

setup-docs

办公与效率

查看项目

更新于 10-15 22:41

技能介绍

用途:在运行 /setup-chalk 或 npx create-chalk 生成占位文档后,一次性深度分析代码库,把 .chalk/docs/ 下所有 PROFILE 占位文档填充为项目专属内容,并补全 chalk.json 中缺失的字段。

适用时机:生成 stub 文档后;PROFILE 文档含 <!-- STUB --> 标记或占位内容时;chalk.json 缺少 routes、sourceLayout 等字段时;代码库发生重大变更后刷新文档。

主要流程:先读取 chalk.json 与各 PROFILE 文档现状,跳过已填充(无 STUB 标记且正文超 20 行)的文档,并读取 package.json、README.md、src/ 结构等代码库内容。随后深挖补全 chalk.json:routes 可按文件路由(app//page.{tsx,jsx}、pages/)或 grep 框架路由配置、Express 路由查找;sourceLayout 扫描标准目录;dev 检查端口与框架默认值;test 检查测试配置与脚本。再依次填充 Product、Engineering、Coding Style、AI、Design 各 PROFILE,并更新 AGENTS.md。最后确认填充与跳过项、剩余缺口,建议下一步。

规则:写实质内容而非 stub,填充后移除 STUB 标记;保留已有真实内容,增强而非覆盖;按文档类型使用相应语气;加入“Last updated: YYYY-MM-DD”行;chalk.json 为权威,与文档冲突时以它为准;优先使用代码库真实示例。

与相关技能区别:/setup-chalk 先创建带 stub 的 .chalk/ 脚手架,setup-docs 后填充真实内容;/create-doc 按需创建单个新文档;/update-doc 更新已有文档;/validate-chalk 校验 chalk.json 与文档的完整性与正确性。