Agent skill

ruanzhu

当用户执行 /ruanzhu 命令或请求生成软著源代码文档时触发。提供软著源代码 DOCX 生成规范。 覆盖项目信息检测、语言扫描规则、页数控制、DOCX 格式规范等。

Stars 424
Forks 44

Install this agent skill to your Project

npx add-skill https://github.com/doccker/cc-use-exp/tree/main/.cursor/skills/ruanzhu

SKILL.md

ruanzhu 技能 - 软著源代码DOCX生成

强制执行规则

必须执行以下命令,禁止任何其他操作:

bash
cp ~/.cursor/templates/ruanzhu/generate_docx.py ./generate_docx.py && python3 generate_docx.py $ARGUMENTS && rm generate_docx.py

禁止事项

  • 自行编写生成脚本
  • 在项目中创建任何 .py 文件
  • 检测 python-docx 是否安装
  • 创建 venv 或手动安装依赖
  • 搜索项目中的文件
  • 执行项目中已有的任何脚本

唯一允许的操作

执行上面的 bash 命令(一条命令,用 && 连接)

执行后状态

  • 生成 docs/ruanzhu/{软件名称}{版本}-源代码.docx
  • 使用 --different 时,生成 {软件名称}{版本}-源代码-2.docx(编号递增)
  • 项目中不应有任何新增的 .py 文件
  • 临时脚本 ./generate_docx.py 已被删除

参考信息(仅供了解,不要自行实现)

以下内容已由 generate_docx.py 脚本实现,不需要手动处理

项目信息检测

按优先级读取项目名称和版本:

  1. README.md / CLAUDE.md:查找标题和版本信息
  2. package.json:name + version
  3. pom.xml:artifactId + version
  4. 用户输入

检测项目语言

检测文件 语言
pom.xmlbuild.gradle Java
package.json JavaScript/TypeScript
Cargo.toml Rust
Gemfile Ruby
go.mod Go
*.cppCMakeLists.txt C++
requirements.txtpyproject.toml Python

源代码扫描规则

Java: src/main/java/**/controller/service/entity/ 等,排除 *Test.java

TypeScript/Vue/React: src/api/src/stores/src/pages/ 等,排除 *.spec.tsnode_modules/

Go: cmd/internal/pkg/,排除 *_test.govendor/

Python: src/app/lib/,排除 test_*.py__pycache__/

C++: src/include/,排除 *_test.cppbuild/

Ruby: app/controllers/app/models/,排除 *_spec.rb

Rust: src/,排除 tests/target/

页数控制

  • 固定页数模式(默认60页):每页约57行,按优先级扫描
  • 自动模式(auto):≤60页输出全部,>60页输出前30+后30页

DOCX格式规范

页面 A4,边距上下2.5cm、左3.0cm、右2.5cm,字体宋体+Courier New 10pt,单倍行距。

错误处理

错误 处理
无法检测项目信息 提示用户输入
未检测到源代码 报错并列出支持的语言
python-docx 未安装 自动 pip install 安装
代码量不足 警告并输出全部

Expand your agent's capabilities with these related and highly-rated skills.

doccker/cc-use-exp

ops-safety

运维安全规范。当用户执行系统级命令(sysctl、iptables、systemctl、Docker 配置、数据库 DDL) 或进行服务器运维操作时触发。 包含命令风险说明模板、回滚方案要求、问题排查原则、Docker/Cloudflare/数据库场景规则等。

424 44
Explore
doccker/cc-use-exp

ui-ux-pro-max

专业级 UI/UX 设计规范,需要高质量界面设计时手动触发或描述"设计感/专业UI"时自动触发。 覆盖视觉层次、配色体系、排版节奏、交互微动效、响应式适配等。 日常前端开发由 frontend-dev skill 覆盖。

424 44
Explore
doccker/cc-use-exp

bash-style

Bash 编写规范。当用户操作 .sh、Dockerfile、Makefile、.yml、.yaml 文件, 或在 Markdown 中编写 bash/shell 代码块时触发。 包含注释规范、文件写入方式、Heredoc 引号规则、权限路径、脚本规范等。

424 44
Explore
doccker/cc-use-exp

redis-safety

Redis 安全与性能规范。当用户操作 Redis 相关代码(go-redis、Jedis、redis-py、ioredis)时触发。 包含禁止 KEYS 命令、SCAN 替代、大 key 控制、Pipeline 批量、TTL 规范等。

424 44
Explore
doccker/cc-use-exp

python-dev

Python 开发规范。当用户操作 .py、pyproject.toml、requirements.txt、setup.py 文件, 或涉及 FastAPI、Django、Flask、pytest、asyncio 开发时触发。 包含 PEP 8 风格、类型注解、异常处理、测试规范、异步编程、性能优化等。

424 44
Explore
doccker/cc-use-exp

size-check

代码简化与文件行数检查。当用户描述"简化代码"、"检查文件大小"、"代码瘦身"时触发。 审查变更代码的复用性、质量和效率;扫描项目文件行数是否超限并给出拆分建议。

424 44
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results