Project Scaffolder
pretend1111/claude-desktop-app
Scaffolds a complete, runnable project from scratch, covering web, Python and Node.js projects, with a working entry point and no placeholder code.
Generates README.md and DESIGN.md skeletons for a module by scanning its structure with a Node script, then lists what to fill in by hand.
SKILL.md written in Chinese; this summary is our English description.
Install README and DESIGN Generator
$ npx skills add fengshao1227/ccg-workflow --skill gen-docs -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install fengshao1227/ccg-workflow gen-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/fengshao1227/ccg-workflow.git skills-src && mkdir -p .claude/skills && cp -r skills-src/dsh-ccg/skills/gen-docs .claude/skills/gen-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 "gen-docs" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/gen-docs into .claude/skills/gen-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "gen-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/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/gen-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 fengshao1227/ccg-workflow --skill gen-docs -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install fengshao1227/ccg-workflow gen-docs --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/fengshao1227/ccg-workflow.git skills-src && mkdir -p .agents/skills && cp -r skills-src/dsh-ccg/skills/gen-docs .agents/skills/gen-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 "gen-docs" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/gen-docs into .agents/skills/gen-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "gen-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 fengshao1227/ccg-workflow --skill gen-docs -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install fengshao1227/ccg-workflow gen-docs --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/fengshao1227/ccg-workflow.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/dsh-ccg/skills/gen-docs .cursor/skills/gen-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 "gen-docs" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/gen-docs into .cursor/skills/gen-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "gen-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/fengshao1227/ccg-workflow.git --path dsh-ccg/skills/gen-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 fengshao1227/ccg-workflow --skill gen-docs -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install fengshao1227/ccg-workflow gen-docs --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/fengshao1227/ccg-workflow.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/dsh-ccg/skills/gen-docs .gemini/skills/gen-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 "gen-docs" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/gen-docs into .gemini/skills/gen-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "gen-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 fengshao1227/ccg-workflow gen-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 fengshao1227/ccg-workflow --skill gen-docs -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/fengshao1227/ccg-workflow.git skills-src && mkdir -p .github/skills && cp -r skills-src/dsh-ccg/skills/gen-docs .github/skills/gen-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 "gen-docs" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/gen-docs into .github/skills/gen-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "gen-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 fengshao1227/ccg-workflow --skill gen-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 fengshao1227/ccg-workflow gen-docs --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/fengshao1227/ccg-workflow.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/dsh-ccg/skills/gen-docs .opencode/skills/gen-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 "gen-docs" agent skill from https://github.com/fengshao1227/ccg-workflow/tree/main/dsh-ccg/skills/gen-docs into .opencode/skills/gen-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "gen-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
gen-docs- GitHub stars
- 5.9k
- Token cost
- ~410 tokens
- SKILL.md length
- 90 words
- Files
- 2 (incl. scripts)
- Skills in repo
- 6
- Repo updated
- First seen
- Licence
- MIT
At a glance
Generates README.md and DESIGN.md skeletons for a module by scanning its structure with a Node script, then lists what to fill in by hand.
- Creating README and DESIGN files for a newly added module
- SKILL.md covers 核心原则, 自动生成, 生成内容 and 智能分析, plus 3 more sections
- Runs JavaScript scripts from its folder; calls node
- Finding modules that have no documentation and giving them a skeleton
What it does
Written in Chinese, the skill runs scripts/doc_generator.js on a module path, with an optional force flag to overwrite existing files. The README skeleton takes the module name from the directory, a description from code docstrings when present, dependencies from requirements.txt or pyproject.toml, an API overview of classes and functions, and an auto-scanned directory tree, and leaves the feature list and usage as templates.
The DESIGN skeleton adds goals and non-goals, an architecture placeholder, core components, a decision-record table, technology choices detected from the code, trade-offs and known limits, security considerations and an initial change history. Python gets the deepest analysis, while Go, TypeScript and Rust get directory structure and dependencies and other languages get basic structure. After generation the author fills in the TODO items using a checklist.
It is meant to fire when a new module is created or when a module lacks documentation, under the rule that a module without documentation should not go live.
When your agent uses it
- Creating README and DESIGN files for a newly added module
- Finding modules that have no documentation and giving them a skeleton
- Regenerating documentation skeletons after a restructure
Example prompts
- “Generate README.md and DESIGN.md skeletons for the payments module.”
- “Regenerate the docs for src/auth and overwrite the existing files.”
- “List the modules in this repo that have no README, then create skeletons for them.”
Requirements
- Node.js 18 or newer
- Compatibility (from SKILL.md): node>=18
- Pre-approved tools (allowed-tools): Bash, Read, Write, Glob
What it can do on your machine
Read from SKILL.md and the folder at commit f349e3d. 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:
BashReadWriteGlob
From allowed-tools in the SKILL.md frontmatter.
Runs code
Ships 1 file in scripts/ (JavaScript), which the agent can run.
Shell commands in SKILL.md call:
node
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
node>=18
From compatibility in the SKILL.md frontmatter.
Context cost
README and DESIGN Generator loads about 410 tokens when it runs. Until then it costs about 27 tokens; SKILL.md has 90 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: notes
The automated check noted patterns worth knowing about, such as sudo or a known installer.
- NotePre-approves every shell command (allowed-tools: Bash)SKILL.md
allowed-tools: Bash, Read, Write, Glob
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); the scripts in this folder are not scanned.
SKILL.md
The full file from fengshao1227/ccg-workflow at commit f349e3d, republished under its MIT licence (© fengshao1227). 90 words, ~410 tokens.
Download SKILL.mdSave it as
.claude/skills/gen-docs/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.- name
- gen-docs
- description
- 文档生成器。自动分析模块结构，生成 README.md 和 DESIGN.md 骨架。当用户提到生成文档、创建README、创建DESIGN、文档骨架、文档模板时使用。在新建模块开始时自动触发。
- allowed-tools
- Bash, Read, Write, Glob
- compatibility
- node>=18
- license
- MIT
- user-invocable
- true
- disable-model-invocation
- false
- argument-hint
- <模块路径> [--force]
📝 造典关卡 · 文档生成器
核心原则
无文档不成模块
文档是模块的身份证
没有身份证的模块不允许上线自动生成
运行文档生成脚本（跨平台）：
# 在 skill 目录下运行
node scripts/doc_generator.js <模块路径>
node scripts/doc_generator.js <模块路径> --force # 强制覆盖已存在的文档
node scripts/doc_generator.js <模块路径> --json # JSON 输出生成内容
README.md 骨架
自动生成的 README.md 包含：
- 模块名称 — 从目录名提取
- 描述 — 从代码文档字符串提取（如有）
- 特性列表 — 待填充
- 依赖 — 从 requirements.txt/pyproject.toml 提取
- 使用方法 — 基础模板
- API 概览 — 从代码提取类和函数列表
- 目录结构 — 自动扫描生成
DESIGN.md 骨架
自动生成的 DESIGN.md 包含：
- 设计概述 — 目标与非目标模板
- 架构设计 — 架构图占位符
- 核心组件 — 从代码提取类列表
- 设计决策 — 决策记录表格模板
- 技术选型 — 自动检测语言和依赖
- 权衡取舍 — 已知限制和技术债务模板
- 安全考量 — 威胁模型和安全措施模板
- 变更历史 — 初始版本记录
智能分析
支持的语言
| 语言 | 分析能力 |
|---|---|
| Python | 类、函数、文档字符串、依赖 |
| Go | 目录结构、依赖 |
| TypeScript | 目录结构、依赖 |
| Rust | 目录结构、依赖 |
| 其他 | 基础目录结构 |
提取的信息
- 模块名称（目录名）
- 主要编程语言
- 代码文件列表
- 类和函数定义（Python）
- 文档字符串（Python）
- 依赖列表
- 入口点文件
自动触发时机
| 场景 | 触发条件 |
|---|---|
| 新建模块 | 模块创建开始时 |
| 缺失文档 | 检测到模块缺少文档时 |
使用流程
1. 运行 doc_generator.js 生成骨架
2. 填充 TODO 标记的内容
3. 补充设计决策和理由
4. 添加使用示例
5. 运行 /verify-module 校验完整性生成后检查清单
README.md
- 填充模块描述
- 补充特性列表
- 添加使用示例
- 确认依赖完整
DESIGN.md
- 明确设计目标
- 记录设计决策
- 说明技术选型理由
- 列出已知限制
© fengshao1227, MIT. 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 1 other file (scripts) in dsh-ccg/skills/gen-docs of fengshao1227/ccg-workflow.
- SKILL.md
- scripts/doc_generator.js
Open the folder on GitHubat commit f349e3d
Compare with similar skills
README and DESIGN Generator 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 |
|---|---|---|---|---|---|---|
| README and DESIGN Generator this skillfengshao1227/ccg-workflow | 5.9k | — | ~410 | Automated safety check: Notes | MIT | |
| Project Scaffolderpretend1111/claude-desktop-app | 496 | 1 repos | ~498 | Automated safety check: Pass | Custom licence | |
| Generate Readmemicrosoft/Agent365-Samples | 112 | — | ~2.6k | Automated safety check: Notes | MIT | |
| Ok Script Codegenbaoxin1100/ok-kes | 100 | — | ~2k | Automated safety check: Pass | None | |
| Swarmauri Add Community Standaloneswarmauri/swarmauri-sdk | 104 | — | ~387 | Automated safety check: Pass | Apache-2.0 | |
| Module Docs Generatortelagod/code-abyss | 243 | — | ~507 | Automated safety check: Notes | MIT |
Similar skills
- Official
Generate Readme
microsoft/Agent365-Samples
Generates or updates a README.md for an Agent 365 sample agent.
Ok Script Codegen
baoxin1100/ok-kes
Generate Python automation code for ok-script task run methods from user descriptions and optional screenshots.
Swarmauri Add Community Standalone
swarmauri/swarmauri-sdk
Add a second-class standalone Swarmauri package under pkgs/community.
Module Docs Generator
telagod/code-abyss
Generates README.md and DESIGN.md skeletons for a module from its directory structure and code, leaving the decision reasoning for a person to fill in.
Full Stack Scaffold
Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI
Unified project scaffolding for Node.js, Python, Rust, and Mobile.
More from fengshao1227/ccg-workflow
Change Verification Gate
fengshao1227/ccg-workflow
Analyzes a code diff for documentation sync, test coverage and impact scope, warning when docs or tests lag behind a design-level change or a large edit.
Module Completeness Check
fengshao1227/ccg-workflow
Scans a module directory for the required README.md and DESIGN.md plus recommended files and reports what is missing, so a module is not delivered incomplete.
Code Quality Gate
fengshao1227/ccg-workflow
Scans code for complexity, long functions, duplicated blocks, naming problems and code smells with a Node script, then reports and suggests refactors.
Security Verification Gate
fengshao1227/ccg-workflow
Scans code with a bundled Node script for injection, secrets, XSS and other risky patterns, ranks findings by severity and checks that security decisions are documented.
Ccg Workflow
fengshao1227/ccg-workflow
How to run a non-trivial change end to end with the CCG role tools (ccganalyze / ccgdesign / ccgbuild / ccgdebug / ccgoptimize / ccgreview / ccgtest) and the verify- quality gates.
Related
Categories
Questions about README and DESIGN Generator
What does README and DESIGN Generator do?
Generates README.md and DESIGN.md skeletons for a module by scanning its structure with a Node script, then lists what to fill in by hand. js on a module path, with an optional force flag to overwrite existing files.toml, an API overview of classes and functions, and an auto-scanned directory tree, and leaves the feature list and usage as templates.
When should I use README and DESIGN Generator?
README and DESIGN Generator fits situations like: creating README and DESIGN files for a newly added module; finding modules that have no documentation and giving them a skeleton; regenerating documentation skeletons after a restructure.
How do I install README and DESIGN Generator in Claude Code?
Run `npx skills add fengshao1227/ccg-workflow --skill gen-docs -a claude-code`. Or copy the skill folder (dsh-ccg/skills/gen-docs in fengshao1227/ccg-workflow) into .claude/skills/gen-docs in your project. Claude Code loads it when a task matches its description.
How do I install README and DESIGN Generator in Codex?
Run `npx skills add fengshao1227/ccg-workflow --skill gen-docs -a codex`. Or copy the skill folder (dsh-ccg/skills/gen-docs in fengshao1227/ccg-workflow) into .agents/skills/gen-docs in your project. Codex loads it when a task matches its description.
Can I use README and DESIGN Generator 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 fengshao1227/ccg-workflow --skill gen-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/gen-docs, .gemini/skills/gen-docs, .github/skills/gen-docs and .opencode/skills/gen-docs in your project.
What does README and DESIGN Generator need to run?
Going by SKILL.md and its folder, README and DESIGN Generator needs JavaScript for the scripts in its folder and the command-line tools its instructions call (node). Our summary lists: Node.js 18 or newer. Its frontmatter pre-approves these tools: Bash, Read, Write, Glob. Compatibility (from SKILL.md): node>=18.
Does README and DESIGN Generator 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 README and DESIGN Generator safe to install?
Our automated static check of SKILL.md found notes only (pre-approves every shell command (allowed-tools: bash)), nothing it rates as a warning. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.
What licence does README and DESIGN Generator use?
README and DESIGN Generator is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does README and DESIGN Generator use?
About 410 tokens (SKILL.md is roughly 1.6k 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 README and DESIGN Generator?
Skills that share tags, products or a category with README and DESIGN Generator: Project Scaffolder (pretend1111/claude-desktop-app, 496 stars), Generate Readme (microsoft/Agent365-Samples, 112 stars), Ok Script Codegen (baoxin1100/ok-kes, 100 stars) and Swarmauri Add Community Standalone (swarmauri/swarmauri-sdk, 104 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains README and DESIGN Generator?
fengshao1227 (a GitHub user) maintains it in fengshao1227/ccg-workflow, which has 5,932 GitHub stars. The repository holds 6 skills in this directory. The repository was last updated on September 15, 2026.
Source: fengshao1227/ccg-workflow on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.