Skip to content

Swcmb/Course-Paper-Generator-Skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Course Paper Generator

基于项目源码自动生成课程论文和课程论文任务书的 AI Skill。支持多种主流技术栈,自动分析项目结构并生成符合学术规范的文档。

✨ 功能特性

  • 智能技术栈识别:自动识别 Java/Python/Node.js/Go/.NET/Rust 等 7 种技术栈
  • Mermaid 图表自动生成:架构图、E-R图、流程图、时序图等全部自动生成
  • 多项目类型支持:Web全栈、Web后端、纯前端、CLI工具、数据分析、移动端
  • 严格内容验证:所有技术描述必须可追溯到源码,未知内容标注明确
  • 学术规范输出:符合课程设计报告格式要求,支持自动生成任务书
  • 多轮用户确认:关键节点需用户确认,确保输出质量

🔧 支持的技术栈

技术栈 构建文件 主流框架
Java/Maven pom.xml Spring Boot, Spring MVC, MyBatis
Java/Gradle build.gradle Spring Boot, JPA, Hibernate
Python requirements.txt, pyproject.toml Django, Flask, FastAPI, SQLAlchemy
Node.js/TypeScript package.json, tsconfig.json Express, NestJS, React, Vue, Prisma
Go go.mod, go.sum Gin, Echo, GORM
C#/.NET *.csproj, *.sln ASP.NET Core, EF Core
Rust Cargo.toml Actix-web, Rocket, Diesel

🚀 使用方法

# 触发方式

当用户提及以下关键词时自动触发:
- "生成课程论文"、"写课程论文"
- "课程设计报告"、"课设报告"
- "课程论文任务书"、"根据代码写论文"
- "项目报告生成"、"软件工程论文"

# 典型输入示例

帮我分析这个 Spring Boot 项目 `e:\code\carrent-master` 并生成课程论文和任务书。我的姓名是张三,学号 2024001,院系计算机学院,专业软件工程,指导教师李教授(副教授)。

📁 项目结构

course-paper-generator/
├── SKILL.md                    # 核心工作流程定义(254行)
├── assets/
│   ├── course_paper_template.md # 课程论文模板(662行,~60个占位符)
│   └── task_book_template.md    # 课程论文任务书模板(111行)
└── references/
    ├── CODE-ANALYSIS-PROMPT.md  # 代码分析提示词(68行)
    ├── PROJECT-ANALYSIS-GUIDE.md # 项目分析指南(627行)
    ├── WRITING-STANDARDS.md     # 写作规范(~680行)
    └── PAPER-TEMPLATE-GUIDE.md  # 模板填充指南(1371行)

🔄 工作流程

本 Skill 按以下七个阶段顺序执行:

阶段 名称 关键输出
阶段一 项目发现与分类 技术栈识别、项目类型判定
阶段二 深度项目分析 模块列表、实体类、外部集成
阶段三 信息采集与验证 用户个人信息表单
阶段四 内容交叉验证 验证结果摘要、标注标记
阶段五 生成任务书 任务书 Markdown 文件
阶段六 生成课程论文 完整课程论文(含 Mermaid 图表)
阶段七 输出文档 两份 Markdown 文件交付

📊 输出文件

生成的文件格式:

  • 课程论文任务书_{专业}_{学号}_{姓名}_{项目名}.md
  • 课程论文_{专业}_{学号}_{姓名}_{项目名}.md

论文包含的 Mermaid 图表类型:

  • graph TD - 分层架构图
  • erDiagram - 数据库实体关系图
  • flowchart - 业务流程图
  • sequenceDiagram - 外部服务交互时序图
  • stateDiagram-v2 - 状态流转图

📋 核心原则

  1. 严禁虚构:所有技术描述必须基于实际源码
  2. 模板一致性:标题层级、措辞风格与范例保持一致
  3. 代码引用规范:正文代码 ≤10 行,附录 ≤60 行/段
  4. 未知即标注:无法确认的数据标注 [需人工验证]
  5. Mermaid 图表:所有图表自动生成,无静态占位符
  6. 来源可追溯:每个技术描述可追溯到具体文件路径

⚠️ 异常场景处理

场景 处理策略
无测试代码 生成"建议测试方案"并标注
无数据库 跳过数据层设计章节
无外部集成 跳过外部集成章节
CLI 工具 跳过 Web 层设计章节
路径无效 提示用户重新指定路径

📝 写作风格

  • 使用"本文"、"本系统"、"本项目"等主语
  • 技术术语使用官方名称和版本号
  • 段落结构:开门见山 → 技术描述 → 实现细节 → 价值总结
  • 章节编号格式:## 1. ### 1.1 #### 1.1.1

🔗 相关资源

  • SKILL.md - 核心工作流程
  • 课程论文模板 - 论文模板
  • 写作规范 - 写作标准
  • 项目分析指南 - 分析方法

📦 安装

.skill 文件安装到 Trae/Claude Code 的 Skills 目录即可使用。


注意:本 Skill 已通过 skill-creator 标准化打包,可直接安装使用。

About

基于项目源码自动生成课程论文和课程论文任务书的 AI Skill

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors