用途:根据当前对话上下文与文件夹内容生成 Markdown 文档,编写或更新项目中的 README.md。README 被视为面向人类用户的当前状态规格说明,不是变更日志、决策记录或历史档案,只记录撰写时的现状,不记录历史信息或已做选择。
主要能力:查找项目内所有 README.md 并逐个更新;每个 README 仅覆盖其所在目录层级及以下内容(同级与子文件夹),不涉及父级;注意子文件夹层级、作用域与限界上下文,避免在不同层级文档间泄漏概念。若用户给出具体指导或重点,会在决定文档侧重时应用该上下文。
使用方式:对每个 README,先读取现有内容,再计算自上次修改以来的变化,涵盖已提交、已暂存、未暂存与未跟踪的工作。使用 git 命令获取基线、日志、diff 与状态,例如 TARGET_README、TARGET_DIR、BASELINE、HEAD_SHA 等变量与 git log、git diff、git status --short 命令;注意 --stat 必须放在 -- 之前,否则 git 会将其视为路径规范并静默输出完整 diff。先读 --stat 摘要再决定是否运行完整 diff;摘要很大时跳过完整 diff,直接读取变更文件。未跟踪文件(??)不在任何 diff 中,需直接读取。随后探索该目录层级及以下的代码库,回顾对话历史中的相关决策、变更或经验,用 diff 与对话上下文判断需更新哪些章节,并核对代码与文档是否一致。若没有值得更新 README 的变化,应说明并跳过。
文档结构:标题与不超过五句的概述;可选图片或视频;架构(组件列表及用途);先决条件(账户、密钥、凭据、工具、运行时、CLI 及需要原因);项目结构(仅文件夹,不含文件,每个附一行用途);安装(安装命令);使用(运行命令);测试(无测试时省略)。目标控制在 500 行以内,过长时把细节移入代码旁的嵌套 README。
相关技能:markdown 规则与语法用 md-syntax(/md-syntax、$md-syntax);写作约定与风格用 md-style(/md-style、$md-style);写完后用 md-lint(/md-lint、$md-lint)对文件格式化与检查。
限制:资料未提供该技能的收费、价格、支持平台或效果信息;不编造功能与步骤。