Issue 010 quickstart
Thesis Skills v1.0.0
guide / cn 2026.04
quickstart

3 分钟跑通 第一个检查

不用读完整文档,先跑一条命令,看输出,再决定要不要继续。

3.10+ Python 版本
零依赖 纯 Python stdlib
6 份 JSON 检查报告
01 / steps

按顺序走七步

每步都有明确输入和可验证的输出。卡住时先看 Step 6 的常见失败。

1

确认环境

Python 3.10 或更高版本。git 已安装。

不需要 LaTeX。demo 模式用 --skip-compile 跳过编译。

2

克隆仓库

$ git clone https://github.com/quzhiii/thesis-skills.git
$ cd thesis-skills
3

运行 demo 检查

$ python run_check_once.py \
  --project-root examples/minimal-latex-project \
  --ruleset university-generic \
  --skip-compile

--project-root:指定项目目录,这里用仓库自带的最小示例。

--ruleset:选择规则包,university-generic 是通用大学论文规则。

--skip-compile:跳过 LaTeX 编译。如果你本地有 LaTeX,可以去掉这个参数。

4

预期输出

命令跑完后,会在 examples/minimal-latex-project/reports/ 目录下生成 6 个 JSON 文件:

examples/minimal-latex-project/reports/
├── run-summary.json              # 所有检查的汇总索引
├── check_references-report.json  # 引用完整性检查
├── check_language-report.json    # 中文语言风格检查
├── check_format-report.json      # 格式规范检查
├── check_content-report.json     # 内容结构检查
└── readiness-report.json         # 总 verdict:PASS / WARN / BLOCK
5

先看这三个文件

先看 readiness-report.json:总 verdict 是什么。PASS 表示通过,WARN 有警告但不阻塞,BLOCK 需要处理后才能继续。

再看 check_language-report.json:中文语言风格检查结果,比如口语化表达、标点混用、重复用词。

最后看 run-summary.json:所有检查的汇总索引,方便你快速定位哪一项需要细看。

6

常见失败和对策

Python 版本过低 升级到 3.10 或更高版本。项目用了 Python 3.10 的语法特性,低版本会直接报错。
找不到项目目录 确认你在 thesis-skills 根目录下运行命令,或者给 --project-root 传绝对路径。
缺少依赖 项目用纯 Python stdlib,一般不需要额外安装。如果报错 ModuleNotFoundError,检查是否在正确的虚拟环境里。
输出目录为空 检查命令参数拼写,特别是 --project-root 和 --ruleset 的值。规则包名称要和 90-rules/packs/ 下的目录名一致。