Skip to content
cccskills
FreePublished on GitHub

gen-docs

Generate README.md and DESIGN.md outlines by inspecting a module's files, language, and dependencies. Python analysis also extracts classes, functions, and docstrings, providing a starting point for usage documentation and design records that you complete afterward.

OriginalShow the original description

文档生成器。自动分析模块结构,生成 README.md 和 DESIGN.md 骨架。当用户提到生成文档、创建README、创建DESIGN、文档骨架、文档模板时使用。

在新建模块开始时自动触发。

See how to install

Good for

  • Create documentation outlines for a new module
  • Add missing README.md and DESIGN.md files
  • Summarize Python classes and functions
  • Prepare sections for design decisions and limitations

Files included (2)

  • SKILL.md2.8 KB
  • scripts/doc_generator.js15.8 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

📝 造典关卡 · 文档生成器

核心原则

无文档不成模块
文档是模块的身份证
没有身份证的模块不允许上线

自动生成

运行文档生成脚本(跨平台):

# 在 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

  • 明确设计目标
  • 记录设计决策
  • 说明技术选型理由
  • 列出已知限制

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

adapt

FreeSummary

Adapts existing designs for phones, tablets, desktops, print, and email. Adjusts layouts, navigation, content priorities, and touch controls to suit each context, with guidance for responsive sizing and verification across devices and input methods.

  • Adapting a desktop interface for mobile use
  • Adjusting tablet layouts for portrait and landscape
  • Expanding a mobile design for desktop screens
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

Audit a website for Google AdSense application readiness or ongoing ad-serving issues. Check content, navigation, crawler access, and disclosures against official requirements, then receive evidence-based findings, specific fixes, and a complete checklist with unresolved questions clearly marked.

  • Checking a site before applying for AdSense
  • Investigating issues after an AdSense rejection
  • Reviewing policy risks on a site that already serves ads
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

ai

FreeSummary

Routes AI development questions to focused references on agents, language model security, retrieval-augmented generation, which uses retrieved information in answers, and prompt design and evaluation. It also outlines principles for validation, safety boundaries, version control, and ongoing assessment.

  • Find guidance for agent development
  • Locate references on prompt injection defenses
  • Explore retrieval and reranking for RAG
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

animate

FreeSummary

Review an interface and add purposeful motion to buttons, forms, navigation, and state changes. Plan and implement animations that clarify actions and provide feedback, while checking performance and supporting users who prefer reduced motion.

  • Adding visual feedback to buttons and forms
  • Smoothing menu, modal, and tab transitions
  • Planning page entrances and scroll reveals
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

architecture

FreeSummary

Find the relevant architectural guidance for API design, security, cloud infrastructure, message queues, and caching. This skill acts as an index to specialized references and lists principles for structuring software, distributed systems, and access controls.

  • Finding guidance for API design
  • Reviewing security architecture topics
  • Exploring containers, K8s, and Serverless
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

arrange

FreeSummary

Improve interface layouts by reviewing spacing, alignment, content density, and visual hierarchy, the cues that show what matters most. Refine repetitive card grids and crowded sections into compositions with consistent spacing and responsive structure.

  • Adjusting spacing in a crowded interface
  • Making important content easier to spot
  • Varying repetitive card-based layouts
fengshao1227/ccg-workflow5.9KUpdated Oct 19, 2026

See all skills by fengshao1227

Report a problem with this skill