docs-update

Installation
SKILL.md

docs-update — 文档与代码对齐

运行环境入口约定:本仓库的 .claude/skills 以 Claude Code 为源,示例默认写 /tunan:*。若同一 skill 在 Codex 中运行,所有面向 sponsor 的可复制入口在输出前改写为 $tunan:*;Claude Code 中保持 /tunan:*。

docs-update 生成并刷新项目文档,保证每一条事实——文件路径、函数签名、CLI 命令、HTTP 端点、配置键——都对照活代码核验过,不出现幻觉路径、幽灵端点或过期签名。它先探测仓库现有的文档结构,列出待办清单,按文档类型派发读取/撰写子代理直接探索代码,再用核验子代理逐条 fact-check,最后一个有界修复循环修正不准确处。

与上游 GSD 的 docs-update 不同点:tunan 不用本地 .planning/ 工作清单文件,也不固定 9 种文档类型——它适配仓库已有的文档布局,把工作清单留在 chat 的任务列表里(TaskCreate/TaskUpdate),产物就是仓库里的 markdown 文档本身。文档是代码树文件,不是 issue,这是本 skill 唯一会写盘的 tunan skill 之一,符合预期。

Interaction Method

决策点一律走平台的阻塞问询工具:AskUserQuestion(Claude Code;schema 未加载时先 ToolSearch select:AskUserQuestion)、request_user_input(Codex)、ask_user(Gemini;Pi 经 pi-ask-user 扩展)。无阻塞工具或调用出错时退化为 chat 编号列表并等待,绝不静默跳过。用于:覆盖已有手写文档前的保留确认、最终写盘前的清单确认。

Argument

<doc_target> #$ARGUMENTS </doc_target>

Installs
20
First Seen
Jul 4, 2026