Nx Generate
nomcopter/react-mosaic
Generate code using nx generators. An agent skill from nomcopter/react-mosaic.
对任意代码项目生成一套面向新人的循序渐进文档集，输出到 docs/ 目录。含架构、设计思想、语言特性、代码导读、运行时模型、构建、对接、调试、设计规范共 9 篇，支持全部生成 / 只写几篇 / 更新已有文档。当用户提到"生成项目文档"、"新人文档"、"上手文档"、"架构文档"、"代码导读"、"项目理解"、"深入理解项目"、"onboarding…
Install Project Docs
$ npx skills add xstongxue/best-skills --skill project-docs -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install xstongxue/best-skills project-docs --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/xstongxue/best-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/project-docs .claude/skills/project-docs && rm -rf skills-srcUse ~/.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/
Install the "project-docs" agent skill from https://github.com/xstongxue/best-skills/tree/main/skills/project-docs into .claude/skills/project-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "project-docs", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/xstongxue/best-skills/tree/main/skills/project-docsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add xstongxue/best-skills --skill project-docs -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install xstongxue/best-skills project-docs --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/xstongxue/best-skills.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/project-docs .agents/skills/project-docs && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "project-docs" agent skill from https://github.com/xstongxue/best-skills/tree/main/skills/project-docs into .agents/skills/project-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "project-docs", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add xstongxue/best-skills --skill project-docs -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install xstongxue/best-skills project-docs --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/xstongxue/best-skills.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/project-docs .cursor/skills/project-docs && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "project-docs" agent skill from https://github.com/xstongxue/best-skills/tree/main/skills/project-docs into .cursor/skills/project-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "project-docs", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/xstongxue/best-skills.git --path skills/project-docs--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add xstongxue/best-skills --skill project-docs -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install xstongxue/best-skills project-docs --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/xstongxue/best-skills.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/project-docs .gemini/skills/project-docs && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "project-docs" agent skill from https://github.com/xstongxue/best-skills/tree/main/skills/project-docs into .gemini/skills/project-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "project-docs", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install xstongxue/best-skills project-docsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add xstongxue/best-skills --skill project-docs -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/xstongxue/best-skills.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/project-docs .github/skills/project-docs && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "project-docs" agent skill from https://github.com/xstongxue/best-skills/tree/main/skills/project-docs into .github/skills/project-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "project-docs", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add xstongxue/best-skills --skill project-docs -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install xstongxue/best-skills project-docs --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/xstongxue/best-skills.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/project-docs .opencode/skills/project-docs && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "project-docs" agent skill from https://github.com/xstongxue/best-skills/tree/main/skills/project-docs into .opencode/skills/project-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "project-docs", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
project-docs- GitHub stars
- 3k
- Token cost
- ~720 tokens
- SKILL.md length
- 137 words
- Files
- 6
- Skills in repo
- 15
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
对任意代码项目生成一套面向新人的循序渐进文档集，输出到 docs/ 目录。含架构、设计思想、语言特性、代码导读、运行时模型、构建、对接、调试、设计规范共 9 篇，支持全部生成 / 只写几篇 / 更新已有文档。当用户提到"生成项目文档"、"新人文档"、"上手文档"、"架构文档"、"代码导读"、"项目理解"、"深入理解项目"、"onboarding…
- Works in 5 steps: ：判断要做哪种 → ：先读项目，把结果记下来 → ：按项目类型决定写哪几篇 → …
- Tasks that involve Project scaffolding
- SKILL.md covers Step 0：判断要做哪种, Phase 1：先读项目，把结果记下来, Phase 2：按项目类型决定写哪几篇 and Phase 3：写, plus 1 more section
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Project Docs is an agent skill from xstongxue/best-skills. 对任意代码项目生成一套面向新人的循序渐进文档集，输出到 docs/ 目录。含架构、设计思想、语言特性、代码导读、运行时模型、构建、对接、调试、设计规范共 9 篇，支持全部生成 / 只写几篇 / 更新已有文档。当用户提到"生成项目文档"、"新人文档"、"上手文档"、"架构文档"、"代码导读"、"项目理解"、"深入理解项目"、"onboarding 文档"、"给新同事看的文档"时使用。要按用户给的格式写论文章节、项目梳理、重点问题、简历项目描述的，用 codegen-doc。
Its SKILL.md is about 720 tokens, which your agent loads only when the skill is triggered. The skill folder holds 6 other files (for example `reference/chapters-01-04.md`, `reference/chapters-05-09.md` and `reference/explore.md`).
It sits in Development, covering Project scaffolding. The licence is Apache-2.0.
When your agent uses it
- Tasks that involve Project scaffolding
Example prompts
- “生成项目文档”
- “深入理解项目”
- “onboarding 文档”
- “/project-docs”
Workflow steps
5 steps, taken from the step headings in SKILL.md.
What it can do on your machine
Read from SKILL.md and the folder at commit 9aa4e55. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
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.
Context cost
Project Docs loads about 720 tokens when it runs. Until then it costs about 63 tokens; SKILL.md has 137 words of instructions outside code blocks.
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
The full file from xstongxue/best-skills at commit 9aa4e55, republished under its Apache-2.0 licence (© xstongxue). 137 words, ~720 tokens.
Download SKILL.mdSave it as
.claude/skills/project-docs/SKILL.md (or your agent's skills folder). This skill also uses 5 other files; get the full folder from GitHub.- name
- project-docs
- description
- 对任意代码项目生成一套面向新人的循序渐进文档集，输出到 docs/ 目录。含架构、设计思想、语言特性、代码导读、运行时模型、构建、对接、调试、设计规范共 9 篇，支持全部生成 / 只写几篇 / 更新已有文档。当用户提到"生成项目文档"、"新人文档"、"上手文档"、"架构文档"、"代码导读"、"项目理解"、"深入理解项目"、"onboarding 文档"、"给新同事看的文档"时使用。要按用户给的格式写论文章节、项目梳理、重点问题、简历项目描述的，用 codegen-doc。
project-docs：项目深度文档生成
输出到项目的 docs/ 目录。核心约束：文档里的代码、类名、路径都必须来自真实文件，见 Phase 3。
Step 0：判断要做哪种
| 用户表述 | 做什么 |
|---|---|
| 生成项目文档 / 新人文档 / 深入理解项目（没指定篇目） | 全部生成，Phase 1 → 2 → 3 → 4 |
| 帮我写架构文档 / 只要代码导读 / 写构建和调试 | 只写指定的几篇，读项目的范围可相应缩小 |
| 代码改了，更新文档 / 文档过期了 | 读 docs/.project-map.md，比对现在的代码，只重写受影响的篇目 |
docs/ 已经有内容时：先列出已有文件，问用户是覆盖、跳过已存在的、还是备份到 docs.bak/。不要直接盖掉。
不该用这个 skill 的情况：用户要的是论文章节、项目梳理、重点问题清单、简历项目描述——也就是给导师、评委、HR、领导看，且格式由对方指定的东西，用 codegen-doc。这个 skill 只管给新同事看、要能照着上手的文档。
Phase 1：先读项目，把结果记下来
记到 docs/.project-map.md。后面每一篇要用的路径、类名、代码，都从这个文件取。
分三步读，不要试图把所有源文件都读完：
- 看轮廓 —— 目录树、构建和依赖文件、README，判断用什么语言、属于哪类项目
- 看骨架 —— 入口文件读全文、接口和类型定义、列出每个模块干什么
- 跟一个完整例子走一遍 —— 挑一个有代表性的示例或功能，从入口追到结束
怎么读、记成什么格式、什么时候可以停，见 reference/explore.md。把那份模板填完再进 Phase 2，其中术语表至少 5 条。
Phase 2：按项目类型决定写哪几篇
01_architecture.md → 架构：项目长什么样
02_philosophy.md → 思想：为什么这样设计
03_lang_concepts.md → 语言特性：读代码前的准备
04_code_walkthrough.md → 代码导读：跟着真实流程走一遍
05_runtime_model.md → 运行时：并发和生命周期
06_build_guide.md → 构建：怎么编译运行
07_integration_guide.md → 对接：怎么写新功能
08_debug_guide.md → 调试：出问题怎么查
09_design_conventions.md → 规范：怎么设计得更好默认模板偏向 C++ 那类"要编译、有多线程、有进程间通信"的项目。前端、数据脚本、库这类项目必须按对照表替换或跳过对应篇目，见 reference/project-types.md。
编号固定，跳过的留空号，不要往前挪。 跳过 05 就是 01,02,03,04,06,07,08,09，原因见 project-types.md。
Phase 3：写
贴代码前先读那个文件
.project-map.md 里只有路径，不是代码原文。要贴哪段代码，先 Read 那个文件确认现在的内容。引用统一带位置：src/core/channel.cpp:120-135。
不这样做，新人会照着一个不存在的类名去搜索——比没有文档更糟。
写给谁看
刚接触项目的新同学。不假设他们了解项目背景，但假设有基础编程能力。
每篇都要有的
- 开头一个
> 一句话说明这篇解决什么问题 - 先说"是什么" → 再说"为什么" → 最后说"怎么做"
- 有对比（❌ 不用框架怎么写 vs ✅ 用框架怎么写）
- 抽象的概念配一个生活里的例子
- 结尾一张速查表或检查清单
图怎么画
| 要表达什么 | 用什么 |
|---|---|
| 调用关系、时序、状态变化、类之间的继承 | Mermaid |
| 目录树、分层框图、内存布局 | ASCII |
ASCII 图宽度控制在 80 字符内，超了在 Typora 和网页里会折行错位。
多长
每篇 300–600 行。不到 300 说明挖得不够深；超过 600 该拆节。避免一篇两千行、另一篇三十行。
用词
同一个东西前后用同一个词，都按 .project-map.md 里的术语表来。在一篇里叫"通道"、另一篇里叫"管道"，是新人最容易卡住的地方。
不要生造名词。能用大白话说清的地方不要起一个新词让读者去记。
不要
- "如上所述"、"综上"这类套话
- 读者已经知道的废话
- 编造代码，见上面第一条
- 术语第一次出现不解释
- 命令和示例没实际跑过却不说明——跑不了的标
⚠️ 未验证
各篇模板：reference/chapters-01-04.md、reference/chapters-05-09.md。
Phase 4：写目录页，然后自查
- 写
docs/README.md，列出所有篇目，说明不同目的该读哪几篇，跳过的篇目写明原因。模板见 reference/quality.md - 每篇对着 quality.md 里的清单过一遍
- 跟用户说清四件事：写了哪几篇各多少行、跳过哪几篇为什么、哪些内容标了
⚠️ 未验证、.project-map.md里还剩什么没弄清。后两条最容易漏，但正是用户判断能不能直接把文档给新人看的依据
© xstongxue, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 5 other files in skills/project-docs of xstongxue/best-skills.
- SKILL.md
- reference/chapters-01-04.md
- reference/chapters-05-09.md
- reference/explore.md
- reference/project-types.md
- reference/quality.md
Open the folder on GitHubat commit 9aa4e55
Compare with similar skills
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.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Project Docs this skillxstongxue/best-skills | 3k | — | ~720 | Automated safety check: Pass | Apache-2.0 | |
| Nx Generatenomcopter/react-mosaic | 4.8k | 7 repos | ~1.9k | Automated safety check: Pass | Custom licence | |
| PonytailDavidObando/gsharp | 564 | 8 repos | ~1.7k | Automated safety check: Pass | MIT | |
| Run Nx Generatornrwl/nx | 29k | 2 repos | ~592 | Automated safety check: Notes | MIT | |
| Conductor Setupgemini-cli-extensions/conductor | 3.8k | — | ~4.2k | Automated safety check: Pass | Apache-2.0 | |
| Mirage VFS Adapter Authoringstrukto-ai/mirage | 3.7k | — | ~2.5k | Automated safety check: Pass | Apache-2.0 |
Similar skills
Ponytail
DavidObando/gsharp
Forces the laziest solution that actually works, simplest, shortest, most minimal.
Run Nx Generator
nrwl/nx
Run Nx generators with prioritization for workspace-plugin generators.
Conductor Setup
gemini-cli-extensions/conductor
Scaffolds the project and sets up the Conductor environment.
Mirage VFS Adapter Authoring
strukto-ai/mirage
Builds or extends a custom Mirage virtual filesystem adapter for an API, database, object store or app data, with a working mount configuration and filesystem tests.
Siteboon Backend Module Standards
siteboon/claudecodeui
Enforces this repository's TypeScript backend module architecture under server/: feature folders, barrel exports, and where shared types and utilities belong.
More from xstongxue/best-skills
All 15 skills in this repoCreate Skill
xstongxue/best-skills
Guides users through creating effective Agent Skills for Cursor.
Office File Process
xstongxue/best-skills
处理 Office 文档的一站式 skill：Word(.doc/.docx/.dotx)、Excel(.xls/.xlsx/.xlsm/.csv)、PowerPoint(.ppt/.pptx/.potx) 的创建、读取、编辑、提取、转换、校验。触发：『读取 word 文档』『提取 excel 内容』『看 ppt 讲了什么』、.doc 老格式打不开、生成/编辑 Word…
Pptgen Drawio
xstongxue/best-skills
根据论文或汇报内容生成多页 Draw.io 格式 PPT，支持论文答辩与通用汇报两种模式，自动导出为 .pptx。当用户提到论文答辩 PPT、答辩幻灯片、通用 PPT、汇报 PPT、根据模板生成 PPT、drawio2pptx 时使用。
Wechat Article Writer
xstongxue/best-skills
公众号/自媒体全流程。根据用户表述自动匹配：撰写文章、封面图、正文插图、风格提取。支持多种写作风格。当用户提到写公众号、技术博客、公众号封面、正文插图、步骤图、演示图、流程示意、分析写作风格、克隆文风、模仿爆款、提取风格时使用。详见 reference 目录。
Drawio Diagram
xstongxue/best-skills
为深度学习模型、网络架构、算法流程等生成标准 Draw.io (.drawio) 格式的可视化图表；支持从零生成与风格迁移两种模式。从零生成：模型架构图、流程图、感受野示意图等；风格迁移：参考图 + 内容描述/项目 → 按参考图风格生成新图。确保 XML 格式正确，可直接在 Draw.io 中打开编辑。
Skill Prompt Convert
xstongxue/best-skills
在 Skill（SKILL.md）与 Prompt（聊天框指令）两种格式之间相互转换。支持 Skill→Prompt 与 Prompt→Skill 双向转换，保持核心信息零丢失。当用户提到 Skill 转 Prompt、Prompt 转 Skill、格式互转、SKILL.md 转换时使用。
Related
Categories
Questions about Project Docs
What does Project Docs do?
对任意代码项目生成一套面向新人的循序渐进文档集，输出到 docs/ 目录。含架构、设计思想、语言特性、代码导读、运行时模型、构建、对接、调试、设计规范共 9 篇，支持全部生成 / 只写几篇 / 更新已有文档。当用户提到"生成项目文档"、"新人文档"、"上手文档"、"架构文档"、"代码导读"、"项目理解"、"深入理解项目"、"onboarding…. Project Docs is an agent skill from xstongxue/best-skills.
When should I use Project Docs?
Project Docs fits situations like: tasks that involve Project scaffolding.
How do I install Project Docs in Claude Code?
Run `npx skills add xstongxue/best-skills --skill project-docs -a claude-code`. Or copy the skill folder (skills/project-docs in xstongxue/best-skills) into .claude/skills/project-docs in your project. Claude Code loads it when a task matches its description.
How do I install Project Docs in Codex?
Run `npx skills add xstongxue/best-skills --skill project-docs -a codex`. Or copy the skill folder (skills/project-docs in xstongxue/best-skills) into .agents/skills/project-docs in your project. Codex loads it when a task matches its description.
Can I use 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 xstongxue/best-skills --skill 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/project-docs, .gemini/skills/project-docs, .github/skills/project-docs and .opencode/skills/project-docs in your project.
What does Project Docs need to run?
SKILL.md names no scripts, command-line tools or credentials: Project Docs is instructions for the agent only.
Does 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 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 Project Docs use?
Project Docs is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Project Docs use?
About 720 tokens (SKILL.md is roughly 2.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Project Docs?
Skills that share tags, products or a category with Project Docs: Nx Generate (nomcopter/react-mosaic, 4.8k stars), Ponytail (DavidObando/gsharp, 564 stars), Run Nx Generator (nrwl/nx, 29k stars) and Conductor Setup (gemini-cli-extensions/conductor, 3.8k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Project Docs?
xstongxue (a GitHub user) maintains it in xstongxue/best-skills, which has 2,962 GitHub stars. The repository holds 15 skills in this directory. The repository was last updated on September 13, 2026.
Source: xstongxue/best-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.