gen-docs SKILL.md skillA
gen-docs from fengshao1227/ccg-workflow is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add fengshao1227/ccg-workflow/gen-docs@git:20260829.3eccf14Pins git:20260829.3eccf14 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- fengshao1227/ccg-workflow
- Path
dsh-ccg/skills/gen-docs/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260829.3eccf14, committed Aug 29, 2026
- Size
- 2,850 bytes
- Repository stars
- 5,957
- License
- MIT
文档生成器。自动分析模块结构，生成 README.md 和 DESIGN.md 骨架。当用户提到生成文档、创建README、创建DESIGN、文档骨架、文档模板时使用。在新建模块开始时自动触发。.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# 📝 造典关卡 · 文档生成器 ## 核心原则 ``` 无文档不成模块 文档是模块的身份证 没有身份证的模块不允许上线 ``` ## 自动生成 运行文档生成脚本（跨平台）： ```bash # 在 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 校验完整性 ``` ## 生成后检查清单 …
Read the whole file at its exact version.
How to install
mdr add fengshao1227/ccg-workflow/gen-docs@sha256:0cbba7ebec8d255dThe line at the top of this page pins the label git:20260829.3eccf14, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_kuzdmdbbinspmypy)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Aug 29, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (2850 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
fengshao1227/ccg-workflow · 5,957 stars · license MIT · pushed 2026-11-02 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_kuzdmdbbinspmypy GET https://markdownregistry.com/api/v1/resolve?ref=fengshao1227/ccg-workflow/gen-docs GET https://markdownregistry.com/api/v1/blob/0cbba7ebec8d255d62cadf13a715eb24a8e4f48989470234be9254c4be6fbc0d
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.