Graduate Report Skill / 研究生课程大作业报告 Skill

面向研究生课程大作业报告的 GitHub-ready 自包含仓库，集成了 LaTeX 模板、学术图表生成脚本和可复用的 AI 写作 skill。

A GitHub-ready standalone repository for graduate course report writing, including LaTeX templates, academic figure generation scripts, and a reusable AI writing skill.

Maintainer / 维护者

1. zanewang
2. 南昌大学计算机技术专业硕士生 / M.S. student in Computer Technology, Nanchang University
3. Email: zanewang8888@outlook.com
4. 这个仓库是我为满足研究生一年级阶段按计算机专业论文格式要求撰写大作业报告而整理出来的。
5. This repository was organized to meet the report-format requirements for graduate first-year computer-related course projects.

What This Repo Includes / 仓库内容

1. paper_example/: 中英文 LaTeX 模板、编译脚本、PDF 合并脚本。
2. figure_example/: 12 类学术风格图表示例与统一样式配置。
3. SKILL.md: 这个仓库作为 AI 写作 skill 的核心规范。
4. PROMPT_TEMPLATE.md: 给助手的标准任务输入模板。
5. WORKFLOW.md 与 checklists/: 从题目到最终 PDF 的工作流和验收清单。
6. figure_example/examples/ 和 paper_example/*.pdf 已保留为示例输出，方便直接预览效果。

Preview / 预览效果

下面展示的是仓库内已保留的部分示例输出，朋友拿到压缩包后无需先运行脚本也能快速了解效果。

The repository keeps sample outputs so readers can preview the style before running any scripts locally.

Figure previews	图表示例

Sample paper PDFs / 示例论文 PDF:

1. Chinese template PDF / 中文模板 PDF
2. English template PDF / 英文模板 PDF
3. Combined PDF / 合并示例 PDF

Installation / 安装

Python Dependencies / Python 依赖

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Windows users can activate the environment with .venv\\Scripts\\activate.

Windows 用户可使用 .venv\\Scripts\\activate 激活虚拟环境。

System Dependencies / 系统依赖

1. LaTeX distribution with pdflatex and xelatex.

2. Optional pdfunite for PDF merging.

3. If pdfunite is unavailable, merge_papers.py can use PyPDF2 as a fallback.

4. 需要安装包含 pdflatex 和 xelatex 的 LaTeX 发行版。

5. pdfunite 可选，用于合并 PDF。

6. 如果没有 pdfunite，merge_papers.py 会使用 PyPDF2 作为备用方案。

Quick Start / 快速开始

1. Generate figures / 生成图表

python figure_example/generate_example_figures.py

2. Copy PDF figures / 复制 PDF 图表

cp figure_example/examples/*.pdf paper_example/figures/

3. Compile the paper / 编译论文

cd paper_example
./compile.sh

Repo Layout / 仓库结构

graduate_report_skill/
├── README.md
├── requirements.txt
├── LICENSE
├── THIRD_PARTY_NOTICES.md
├── SKILL.md
├── PROMPT_TEMPLATE.md
├── WORKFLOW.md
├── PROJECT_STRUCTURE.md
├── .gitignore
├── checklists/
├── figure_example/
└── paper_example/

Template Provenance / 模板来源

1. paper_example/IEEEtran.cls comes from the official IEEEtran LaTeX class.
2. 文件头部显示版本为 2015/08/26 V1.8b，维护者为 Michael Shell。
3. 当前模板使用 \documentclass[lettersize,journal]{IEEEtran}，属于通用 journal 模式。
4. Based on the files currently included in this repository, no specific IEEE journal can be identified.
5. 当前能够确认的是：该模板基于官方 IEEEtran class 的 journal 模式。

License / 许可证

1. 本仓库原创内容采用 MIT License。
2. paper_example/IEEEtran.cls is a third-party file and remains under its original license.
3. See THIRD_PARTY_NOTICES.md for details.

Recommended Reading / 推荐阅读顺序

1. README.md
2. requirements.txt
3. SKILL.md
4. PROMPT_TEMPLATE.md
5. WORKFLOW.md
6. checklists/

Contact / 联系方式

• Email: zanewang8888@outlook.com