Token导航 LogoToken导航

Agent Skill · 开发

project-doc-updater(项目文档更新程序)

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径,不要把未确认的信息写成确定结论;涉及对外文案时,还需要控制语气,避免过度营销或夸大能力。

project-doc-updater 是开发类 Agent Skill,可用宿主为 Codex、Claude、Cursor、Gemini CLI,通过GitHub 仓库获取,权限为只读;许可证信息还不明确,第三方扫描已通过,按安装量在开发类的 21,746 个 Skill 里排第 20,764。

总安装 212周安装 9GitHub Stars 179下载 74核验 2026-05-01

安装说明

本站只整理中文说明,不托管安装包,也不代用户安装。
GitHub
许可证
unknown

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:project-doc-updater(项目文档更新程序)
来源仓库:https://github.com/mingyuepop/specforge
仓库路径:skills/project-doc-updater
安装命令:
npx skills add https://github.com/mingyuepop/specforge --skill project-doc-updater
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

skills.shnpx skills
npx skills add https://github.com/mingyuepop/specforge --skill project-doc-updater

这个 Skill 是做什么的

开发类 Skill 面向写代码、改代码和排查问题,一般会读写仓库文件,部分还会执行构建或测试命令。

project-doc-updater 用于辅助文档、README、Markdown 等内容稿件的整理与改写,帮助 Agent 提炼结构、补齐章节、统一术语或检查链接。适用于项目文档维护、内容稿件优化和说明文撰写等开发协作场景。使用时需保留项目已有事实和命令路径,避免将未确认信息写成确定结论。

涉及对外文案时,应控制语气,防止过度营销或夸大能力描述。建议结合具体项目路径使用,并核实权限范围以避免误写或越权操作。

来源仓库内路径:skills/project-doc-updater

上手步骤

4 步
  1. 1

    确认自己的宿主工具

    公开资料标注支持 Codex、Claude、Cursor、Gemini CLI;先确认自己用的是其中之一,再按对应工具的 Skills 目录放置。

  2. 2

    拿到安装命令

    可以直接复制的命令是 npx skills add https://github.com/mingyuepop/specforge --skill project-doc-updat…;命令里的占位符换成自己的路径或密钥再执行。

  3. 3

    安装后重启宿主

    命令执行完要完全退出宿主工具再打开,让新装的 Skill 被重新扫描到,否则列表里可能看不到。

  4. 4

    按最小权限试用

    它标注为只读,先用只读任务试一次,确认行为符合预期再扩大使用范围。

常见问题

6 条

project-doc-updater 怎么安装?

在终端执行 npx skills add https://github.com/mingyuepop/specforge --skill project-doc-updater。装完完全退出宿主工具再打开,让它重新扫描本地 Skill。

project-doc-updater 支持哪些 AI 工具?

公开资料标注支持 Codex、Claude、Cursor、Gemini CLI。其他工具只要能读取本地 Skill 目录,一般也能手动放进去,但要自己确认触发方式是否一致。

project-doc-updater 需要什么权限?

权限级别是只读。该 Skill 主要提供规则、说明或参考内容,本身偏只读;真正读写文件、联网或执行命令仍取决于宿主 Agent 的任务。

project-doc-updater 是免费的吗?

公开资料没有标注明确许可证,收费和商用限制都无法确认。正式使用前请到来源仓库核对授权说明。

project-doc-updater 用的人多吗?

公开数据是累计安装 212 次,近一周安装 9 次,下载 74 次,GitHub 179 星。这些数字来自第三方目录统计,只能当作热度参考,不代表质量或安全性。

project-doc-updater 安全吗?

第三方扫描结果为通过,但这只覆盖已知的静态检查项,不能替代自己读一遍源码和安装命令。

值得选的地方和要先想清楚的地方

值得选的地方

  • 同时适配 4 种工具,换客户端不用重新找替代品。
  • 第三方扫描已通过,常见的高风险行为没有命中。
  • 标注为只读权限,试用阶段不容易误改本地文件。

先想清楚的地方

  • 许可证没有明确标注,能不能商用、能不能再分发都不确定。
  • 第三方目录整理,版本更新和行为细节以来源仓库为准。

适不适合你

更适合

  • 已经在用 Codex,想直接扩展它能力的人。
  • 需要处理开发类任务、又不想每次都手写提示词的人。
  • 只想先试试效果、不希望它改动本地文件的人。

不太适合

  • 需要明确授权才能用到公司项目里的场景。
  • 需要厂商级技术支持和 SLA 的生产系统。

开发类 Skill 对比

6 个同类
Skill总安装GitHub 星权限许可证扫描
skill-vetter

技能审查员 · OpenClaw

8,779,018986操作浏览器MIT-0通过
ontology

本体论 · OpenClaw

6,636,960576只读MIT-0通过
entra-app-registration

内部应用程序注册 · Codex、Claude

6,631,872764接触敏感数据未明确通过
entra-app-registration

内部应用程序注册 · Codex、Claude

3,757,680201接触敏感数据未明确通过
nano-banana-pro

纳米香蕉专业版 · OpenClaw

3,526,898364接触敏感数据MIT-0有提醒
project-doc-updater

项目文档更新程序 · 本页

212179只读未明确通过

按安装量取同分类前几名;数字来自第三方目录统计,只作热度参考,不代表质量结论。

SKILL.md 原文

项目文档更新器 (Project Documentation Updater)

角色

你是 文档守护者 (Documentation Guardian)。你的目标是确保项目文档(特别是 .trae/rules/ 和 .ai-specs/ 目录下的文档)准确反映代码库的当前状态。

何时使用

  • 当用户明确要求“更新文档”或“同步文档”时。
  • 当你检测到代码实现(例如:技术栈、文件夹结构)与文档规范发生了偏差时。
  • 在完成重大功能实现后,如果该功能改变了项目结构或引入了新技术。

边界守卫 (Guardrails) - CRITICAL

请严格遵守通用边界守卫规则:specs/GUARDRAILS.md 当前阶段: 规划与管理阶段 (Planning & Management)

工作流程

  1. 分析上下文 (Analyze Context):

- 阅读当前代码库,理解实际状态(技术栈、项目结构、关键功能)。 - 阅读现有的文档文件: - specs/1_产品概述.md (产品概述) - specs/2_技术栈.md (技术栈) - specs/3_项目结构.md (项目结构) - specs/*.md (任何生效的规则)

  1. 识别偏差 (Identify Deviations):

- 对比实际代码与文档规范。 - 列出具体的差异点(例如:“文档说是 MySQL,但代码里用了 PostgreSQL”)。

  1. 更新文档 (Update Documentation):

- 动作:修改文档文件以匹配代码。代码是唯一的事实来源 (The Code is the Source of Truth)。 - 风格:保持文档现有的格式和语气。 - 验证:确保更新后的文档之间保持一致。

  1. 报告 (Report):

- 告知用户你更新了什么以及为什么更新。 - 示例:“我注意到您使用了 pnpm 而不是 npm,所以我更新了 2_技术栈.md 以反映这一变化。”

安全事项

  • 不要删除整段内容,除非它们明显已经过时。
  • 如果偏差模棱两可(例如:遗留代码 vs 新文档),在覆盖前先询问用户。

平台分布

Codex

35.37%
按下载量换算26

Claude

31.11%
按下载量换算23

Cursor

18.86%
按下载量换算14

Gemini CLI

8.98%
按下载量换算7

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

只读

该 Skill 主要提供规则、说明或参考内容,本身偏只读;真正读写文件、联网或执行命令仍取决于宿主 Agent 的任务。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。目前只有一个公开来源,建议同时核对源仓库。

继续浏览同类 Skills