Agent skill

Build Project Docs

by zrt-ai-lab in zrt-ai-lab/opencode-skills

为项目构建分层式LLM友好文档体系。已有项目:扫描项目结构→架构分类→生成CLAUDE.md主索引→基础模块文档→业务模块API/数据模型/坑点文档→配置文档→git变更日志(含风险评估+回滚指南)→交叉验证。新项目:解析PRD→按脚手架规范设计架构→需求拆解为开发任务→融合代码规范生成CLAUDE.md开发指南→模块级API设计+数据模型+开发清单。当用户需要为项目创建AI编程文档、建立项目索…

No licenceAuto-check passedProduct & Project Management

Install Build Project Docs

skills CLI
$ npx skills add zrt-ai-lab/opencode-skills --skill build-project-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install zrt-ai-lab/opencode-skills build-project-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/zrt-ai-lab/opencode-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/build-project-docs .claude/skills/build-project-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
build-project-docs
GitHub stars
287
Token cost
~893 tokens
SKILL.md length
183 words
Files
18 (incl. references)
Skills in repo
26
Repo updated
First seen
Licence
None found

At a glance

为项目构建分层式LLM友好文档体系。已有项目:扫描项目结构→架构分类→生成CLAUDE.md主索引→基础模块文档→业务模块API/数据模型/坑点文档→配置文档→git变更日志(含风险评估+回滚指南)→交叉验证。新项目:解析PRD→按脚手架规范设计架构→需求拆解为开发任务→融合代码规范生成CLAUDE.md开发指南→模块级API设计+数据模型+开发清单。当用户需要为项目创建AI编程文档、建立项目索…

  • Works in 6 steps: 先检查… → 如果 _progress.md 不存在,阅读现有… → 运行阶段1获取当前状态 → …
  • Tasks that involve PRD writing
  • SKILL.md covers 核心理念, 模式检测, 文档模式(8个阶段) and 新项目模式(5个阶段), plus 2 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Build Project Docs is an agent skill from zrt-ai-lab/opencode-skills. 为项目构建分层式LLM友好文档体系。已有项目:扫描项目结构→架构分类→生成CLAUDE.md主索引→基础模块文档→业务模块API/数据模型/坑点文档→配置文档→git变更日志(含风险评估+回滚指南)→交叉验证。新项目:解析PRD→按脚手架规范设计架构→需求拆解为开发任务→融合代码规范生成CLAUDE.md开发指南→模块级API设计+数据模型+开发清单。当用户需要为项目创建AI编程文档、建立项目索引、梳理代码、新建项目规划、或提到llm.txt/CLAUDE.md时使用。

Its SKILL.md is about 890 tokens, which your agent loads only when the skill is triggered. The skill folder holds 21 other files, including reference files (for example `README.md`, `references/docs/phase-1-explore.md` and `references/docs/phase-2-classify.md`). Compatibility notes: 需要 git

It sits in Product & Project Management, covering PRD writing and Agent instruction files. It works with Git. The repository describes itself as: OpenCode/Claude Code 技能库 。特色技能:视频生成、图片生成、AI Agent 互联、智能问数等等各场景,持续开发更新中.

When your agent uses it

  • Tasks that involve PRD writing
  • Tasks that involve Agent instruction files

Example prompts

  • “/build-project-docs”

Requirements

  • Compatibility (from SKILL.md): 需要 git
  • Pre-approved tools (allowed-tools): Bash(git:*,find:*,wc:*,head:*,ls:*), Read, Write, Edit, Glob, Grep

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

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

What it can do on your machine

Read from SKILL.md and the folder at commit d38536f. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Bash(git:*
    • find:*
    • wc:*
    • head:*
    • ls:*)
    • Read
    • Write
    • Edit
    • Glob
    • Grep

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

  • Compatibility

    需要 git

    From compatibility in the SKILL.md frontmatter.

Context cost

Build Project Docs loads about 893 tokens when it runs, and up to ~8.7k if it reads all its reference files. Until then it costs about 64 tokens; SKILL.md has 183 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~64
When it runs · the whole SKILL.md, loaded when a task matches
~893
With references · SKILL.md plus every file in references/, read only if the agent opens them
~8.7k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Without a licence we can't republish the file, so here is its outline and opening line. It has 183 words (~893 tokens).

name
build-project-docs
allowed-tools
Bash(git:*,find:*,wc:*,head:*,ls:*), Read, Write, Edit, Glob, Grep
compatibility
需要 git
metadata.author
zhairuitao
metadata.version
1.0
metadata.language
zh-CN

Read the full SKILL.md on GitHub

Files

SKILL.md and 17 other files (references) in build-project-docs of zrt-ai-lab/opencode-skills.

  • SKILL.md
  • README.md
  • references/docs/phase-1-explore.md
  • references/docs/phase-2-classify.md
  • references/docs/phase-3-index.md
  • references/docs/phase-4-foundation.md
  • references/docs/phase-5-business.md
  • references/docs/phase-6-config.md
  • references/docs/phase-7-changelog.md
  • references/docs/phase-8-verify.md
  • references/docs/principles.md
  • references/new-project/phase-1-prd.md
  • references/new-project/phase-2-scaffold.md
  • references/new-project/phase-3-breakdown.md
  • references/new-project/phase-4-guide.md
  • references/new-project/phase-5-devdocs.md
  • references/standards/java-code.md
  • … and 1 more

Open the folder on GitHubat commit d38536f

Compare with similar skills

Build Project Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Build Project Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Build Project Docs this skillzrt-ai-lab/opencode-skills287—~893Automated safety check: PassNone
Setup Matt Pocock Skillsywwynm/EverythingDone1449 repos~1.7kAutomated safety check: PassGPL-3.0
Ad ReviewCorridorTech/PoseCap224—~2.4kAutomated safety check: NotesApache-2.0
CCPM Project Managementautomazeio/ccpm8.4k—~1.1kAutomated safety check: PassMIT
Reviewfossasia/eventyay-interpretation1.6k35 repos~996Automated safety check: PassApache-2.0
Graphsmallnest/goal-workflow289—~3.9kAutomated safety check: PassMIT

Similar skills

  • Setup Matt Pocock Skills

    ywwynm/EverythingDone

    Sets up an Agent skills block in AGENTS.md/CLAUDE.md and docs/agents/ so the engineering skills know this repo's issue tracker (GitHub or local markdown), triage label vocabulary, and domain doc…

    144 GitHub starsUsed in 9 repos~1.7k tokens
    Agent WorkflowsAuto-check passed
  • Ad Review

    CorridorTech/PoseCap

    Two-axis fresh-context code review per WORKFLOW §10. An agent skill from CorridorTech/PoseCap.

    224 GitHub stars~2.4k tokensUpdated yesterday
    DevelopmentAuto-check: notes
  • Runs a spec-driven workflow from PRD to epic to GitHub issues to parallel agents, with status, standup and blocked-work reports from bundled scripts.

    8.4k GitHub stars~1.1k tokensUpdated 6 mo ago
    Product & Project ManagementAuto-check passed
  • Review

    fossasia/eventyay-interpretation

    Review the changes since a fixed point (commit, branch, tag, or merge-base) along two axes — Standards (does the code follow this repo's documented coding standards?) and Spec (does the code match…

    1.6k GitHub starsUsed in 35 repos~996 tokens
    Product & Project ManagementAuto-check passed
  • Graph

    smallnest/goal-workflow

    Graph engineering for parallel task execution: convert a task, PRD, SPEC, or issue set into a dependency graph (DAG), layer it into supersteps, then implement each independent node concurrently with…

    289 GitHub stars~3.9k tokensUpdated 25 days ago
    Product & Project ManagementAuto-check passed
  • Fireauto Init Guide

    imgompanda/fireauto

    새 프로젝트를 시작할 때 자동으로 PRD, CLAUDE.md, Wiki, 마일스톤을 생성하세요. An agent skill from imgompanda/fireauto.

    140 GitHub stars~400 tokensUpdated 6 mo ago
    Product & Project ManagementAuto-check passed

More from zrt-ai-lab/opencode-skills

All 26 skills in this repo
  • Wechat Publisher

    zrt-ai-lab/opencode-skills

    This skill should be used when preparing Markdown articles for a WeChat Official Account draft box, selecting wenyan-cli themes, processing article images, or troubleshooting authentication and…

    287 GitHub stars~465 tokensUpdated 2 mo ago
    Auto-check passed
  • Codex Image Service

    zrt-ai-lab/opencode-skills

    A skill your agent uses when Codex needs native image generation, editing, or engineered multi-image composition, especially sets, material kits, grids, storyboards, carousels, presentations…

    287 GitHub stars~2k tokensUpdated 2 mo ago
    Auto-check passed
  • Smart Query

    zrt-ai-lab/opencode-skills

    智能数据库查询技能。通过SSH隧道连接线上数据库,支持自然语言转SQL、执行查询、表结构探索。当用户需要查询数据库、问数据、看表结构时使用此技能。

    287 GitHub stars~484 tokensUpdated 2 mo ago
    Auto-check passed
  • Video Creator

    zrt-ai-lab/opencode-skills

    视频创作技能。图片+音频合成视频,支持TTS配音、淡入淡出转场、字幕、片尾、BGM。当用户提到「生成视频」「做视频」「教学视频」「图文转视频」「做视频号」「配音视频」「图文结合视频」「古诗视频」「故事视频」时触发。内含生图→配音→合成全流程,无需单独调用image-service。

    287 GitHub stars~3.3k tokensUpdated 2 mo ago
    Auto-check passed
  • Searchnews

    zrt-ai-lab/opencode-skills

    当用户要求"搜索新闻"、"查询AI新闻"、"整理新闻"、"获取某天的新闻",或提到需要搜索、整理、汇总指定日期的AI行业新闻时,应使用此技能。

    287 GitHub stars~1.8k tokensUpdated 2 mo ago
    Auto-check passed
  • Skill Scanner

    zrt-ai-lab/opencode-skills

    A skill your agent uses when reviewing an agent Skill before sharing, installing, or executing it and when checking a Skill bundle for credentials, dangerous commands, suspicious network behavior…

    287 GitHub stars~317 tokensUpdated 2 mo ago
    Auto-check passed

Works with

Questions about Build Project Docs

What does Build Project Docs do?

为项目构建分层式LLM友好文档体系。已有项目:扫描项目结构→架构分类→生成CLAUDE.md主索引→基础模块文档→业务模块API/数据模型/坑点文档→配置文档→git变更日志(含风险评估+回滚指南)→交叉验证。新项目:解析PRD→按脚手架规范设计架构→需求拆解为开发任务→融合代码规范生成CLAUDE.md开发指南→模块级API设计+数据模型+开发清单。当用户需要为项目创建AI编程文档、建立项目索…. Build Project Docs is an agent skill from zrt-ai-lab/opencode-skills.

When should I use Build Project Docs?

Build Project Docs fits situations like: tasks that involve PRD writing; tasks that involve Agent instruction files.

How do I install Build Project Docs in Claude Code?

Run `npx skills add zrt-ai-lab/opencode-skills --skill build-project-docs -a claude-code`. Or copy the skill folder (build-project-docs in zrt-ai-lab/opencode-skills) into .claude/skills/build-project-docs in your project. Claude Code loads it when a task matches its description.

How do I install Build Project Docs in Codex?

Run `npx skills add zrt-ai-lab/opencode-skills --skill build-project-docs -a codex`. Or copy the skill folder (build-project-docs in zrt-ai-lab/opencode-skills) into .agents/skills/build-project-docs in your project. Codex loads it when a task matches its description.

Can I use Build Project Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add zrt-ai-lab/opencode-skills --skill build-project-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/build-project-docs, .gemini/skills/build-project-docs, .github/skills/build-project-docs and .opencode/skills/build-project-docs in your project.

What does Build Project Docs need to run?

SKILL.md names no scripts, command-line tools or credentials: Build Project Docs is instructions for the agent only. Its frontmatter pre-approves these tools: Bash(git:*,find:*,wc:*,head:*,ls:*), Read, Write, Edit, Glob, Grep. Compatibility (from SKILL.md): 需要 git.

Does Build Project Docs access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Build Project Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Build Project Docs use?

No licence was found for Build Project Docs or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.

How many tokens does Build Project Docs use?

About 893 tokens (SKILL.md is roughly 3.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 7.8k tokens, read only when the agent opens those files.

What are the alternatives to Build Project Docs?

Skills that share tags, products or a category with Build Project Docs: Setup Matt Pocock Skills (ywwynm/EverythingDone, 144 stars), Ad Review (CorridorTech/PoseCap, 224 stars), CCPM Project Management (automazeio/ccpm, 8.4k stars) and Review (fossasia/eventyay-interpretation, 1.6k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Build Project Docs?

zrt-ai-lab (a GitHub user) maintains it in zrt-ai-lab/opencode-skills, which has 287 GitHub stars. The repository holds 26 skills in this directory. The repository was last updated on July 22, 2026.

Source: zrt-ai-lab/opencode-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.