Token导航 LogoToken导航TokenDH.com
研究检索需要联网github未标认证来源可访问许可证需确认审计异常

build-project-docs构建项目文档

Agent Skill

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

总安装

346

周安装

14

GitHub Stars

192

下载量

109
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

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

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

命令行安装

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

skills.shnpx skills
npx skills add https://github.com/zrt-ai-lab/opencode-skills --skill build-project-docs

简介

build-project-docs 辅助创建分层式 LLM 友好文档体系,支持已有项目梳理或从零基于 PRD 驱动开发。

  • 适用于需要结构化 README、模块级说明与变更日志的项目文档建设场景。
  • 自动检测文档模式并推进八阶段流程,包括主索引生成、模块文档拆分与进度追踪。
  • 使用时应保留事实信息,避免虚构结论;涉及对外文案时需控制语气,防止过度营销。
  • 适用宿主包括 Codex、Claude、Cursor、Gemini CLI,接入前应确认版本、权限和运行环境要求。

SKILL.md

构建项目文档体系 (build-project-docs)

为项目创建完整的分层式 LLM 友好文档。支持两种模式:已有项目梳理文档、新项目从 PRD 驱动开发。

核心理念

LLM上下文窗口有限,文档必须分层:

  • .claude/CLAUDE.md = 主索引(项目地图,始终加载到上下文)
  • .claude/docs/{模块}/README.md = 模块级文档(按需加载)
  • **.claude/docs/{模块}/*.md** = 深度参考文档(API详情、数据模型、坑点)
  • .claude/docs/{模块}/CHANGELOG.md = 模块变更历史(调试和回滚参考)

模式检测

开始前先判断当前模式:

文档模式(已有项目,有源代码)

项目已有代码,需要梳理生成文档。

全新(无 .claude/docs/)→ 按顺序执行文档模式全部8个阶段。

增量.claude/docs/ 已存在)→

  1. 先检查 .claude/docs/_progress.md——如果存在,说明上次会话中断,读取它确定:

- 阶段状态:哪些阶段已完成、哪个阶段进行中、哪些待执行 - 模块进度:阶段4/5/7中哪些模块已完成、哪些待处理 - 直接跳到第一个未完成的阶段继续,不重复已完成的阶段

  1. 如果 _progress.md 不存在,阅读现有.claude/CLAUDE.md 和所有.claude/docs/ 文件
  2. 运行阶段1获取当前状态
  3. 对比:新模块→加入,文件数变化→更新,缺失→创建,过期→更新
  4. 跳过已完成且准确的阶段
  5. 阶段7和阶段8 特殊处理:即使 _progress.md 标记为已完成,如果源码比文档更新(find -newer 检测),仍需重新运行

新项目模式(PRD驱动)

用户提到 PRD、需求文档、新项目规划、开发规范,且项目为空或新建 → 执行新项目模式5个阶段。

用户提到 PRD + 项目已有代码 → 先用文档模式梳理现有代码,再用新项目模式的阶段1-3做增量功能的需求拆解。


文档模式(8个阶段)

为已有项目梳理代码、生成分层文档。

阶段内容详细流程
1项目探查phase-1-explore.md
2架构分类phase-2-classify.md
3编写.claude/CLAUDE.mdphase-3-index.md
4基础模块文档phase-4-foundation.md
5业务模块文档phase-5-business.md
6配置层文档phase-6-config.md
7变更日志phase-7-changelog.md
8交叉验证phase-8-verify.md

执行前必须阅读对应阶段的 reference 文件。


新项目模式(5个阶段)

从 PRD 出发,生成架构设计、需求拆解、开发规范、模块文档。

阶段内容详细流程
1PRD 解析phase-1-prd.md
2架构设计phase-2-scaffold.md
3需求拆解phase-3-breakdown.md
4生成 CLAUDE.md 开发指南phase-4-guide.md
5模块开发文档phase-5-devdocs.md

开发规范参考:

执行前必须阅读对应阶段的 reference 文件。


关键规则

上下文管理(最重要!)

处理多模块时,禁止一次性处理所有模块。必须:

  1. 逐模块串行处理(从小到大)
  2. 每完成一个模块 → 更新 _progress.md → 不再引用该模块源码
  3. 处理 3+ 个大模块后 → 主动提示用户开新会话继续

进度追踪(_progress.md

_progress.md全局进度文件,两种模式通用:

  • 每完成一个阶段或一个模块 → 立即更新 _progress.md
  • 新会话读取后可直接跳到断点继续
  • 全部完成后删除

文档完整性

  • ❌ 只写 README 不写 api 子文件就算"完成"
  • ✅ 只要模块对外暴露了 API(Controller / @Tool / gRPC / Handler 等),就必须按业务域拆分 api-{域}.md
  • ✅ 每个业务模块必须有 data-model.md + pitfalls.md(文档模式)或 data-model.md + dev-checklist.md(新项目模式)
  • ✅ README 是索引,api-*.md 才是详情,README 中必须链接到所有子文件

文件大小

  • .claude/CLAUDE.md:150行以内
  • 模块 README.md:200行以内
  • 超过250行必须拆分子文件

核心原则

详见 principles.md


开始执行

根据模式检测结果,进入对应的阶段流程。每个阶段先展示结果给用户确认,再继续下一阶段。

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

Codex

37.18%
按下载量换算41

Claude

29.02%
按下载量换算32

Cursor

16.98%
按下载量换算19

Gemini CLI

8.4%
按下载量换算9

安全审计

Gen Agent Trust Hub

通过

Socket

未通过

Snyk

通过

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API;具体网络访问范围需要结合源码和 README 复核。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。来源安全扫描存在 warning/failed 结果,不能写成本站确认安全。当前只有一个来源,正式发布前建议补源仓库或其他目录站核验。

来源信息

继续浏览同类 Skills