Wookai/paper-tips-and-trricks · 上手攻略
- 仓库:Wookai/paper-tips-and-tricks
- 链接:https://github.com/Wookai/paper-tips-and-tricks
- 分类:academic-writing
- 作者:Tom
- 更新:2026-08-19
是什么
这是一份学术论文写作最佳实践指南,由 EPFL(洛桑联邦理工学院)研究团队维护,收集了他们在撰写 LaTeX 学术论文过程中积累的排版、图表、文献管理经验。仓库以 Markdown + LaTeX 示例代码的形式呈现,涵盖从"一行一句"源码原则到 Python/Matlab 图表生成规范的全链路技巧。
它不是工具库,不需要安装,是纯经验文档,适合在写论文时随时查阅参考。
解决什么问题
- 排版不一致:不同合作者使用不同 LaTeX 风格,Git 合并时频繁冲突,论文格式五花八门。
- 图表不专业:图表字号与正文不匹配、表格用垂直线、多图拼接不统一,细节问题累积影响审稿人印象。
- 数字单位混乱:文中数字和单位写法不规范(如"123456 dollars"),导致可读性差。
- 文献管理混乱:参考文献格式不统一,CrossRef 引用容易断裂,arXiv 预印本和正式发表版本混用。
- 变量符号混淆:数学符号没有统一规范,向量、矩阵、标量混用导致审稿人困惑。
核心内容速览
排版原则
一行一句(One Sentence Per Line)——将每个句子单独放在一行,而非传统的一个段落连续换行:
% ✅ 正确:一句一行
This is my first sentence.
This is the second one.
This is the third one.
% ❌ 错误:句子挤在一起
This is my first sentence. This is the second one. This is the third one.
好处:Git diff 能精确定位哪句话被修改,合作者 Code Review 效率大幅提升。
标题大小写(Title Case vs Sentence Case):
% 章节标题用 Title Case
\section{The Overview of Neural Networks}
% 列名(Table column heads)用 Sentence Case
% 遵从 Chicago Manual of Style
Name & {Value} \\
防断行(~ 符号):
% ~ 阻止在 "Figure" 和编号之间换行
Figure~\ref{fig:example} displays that...
% 自定义引用命令,避免漏用 ~
\newcommand{\reffig}[1]{Figure~\ref{#1}}
表格规范
使用 booktabs 包(三线表):
\usepackage{booktabs}
\begin{table}
\centering
\begin{tabular}{lcc}
\toprule
& \multicolumn{2}{c}{Data} \\
\cmidrule(lr){2-3}
Name & Column 1 & Another column \\
\midrule
Some data & 10 & 95 \\
Other & 30 & 49 \\
\addlinespace
Different & 99 & 12 \\
\bottomrule
\end{tabular}
\caption{My caption.}
\label{tab-label}
\end{table}
原则:避免垂直线,用 \cmidrule 分组列,用 \addlinespace 替代水平线制造呼吸感。
数字与单位
使用 siunitx 包统一格式化:
\usepackage{siunitx}
% 货币
This thing costs \SI{123456}{\$}.
% 百分比
There are \num{987654} people in this room,
\SI{38}{\percent} of which are male.
% 四舍五入
\sisetup{
round-mode = places,
round-precision = 3
}
\num{1.23456} % → 1.235
数学符号规范
% 自定义数学命令,保持全文字符一致
\newcommand{\mat}[1]{\mathbf{#1}} % 矩阵:大写粗体
\newcommand{\vec}[1]{\mathbf{#1}} % 向量:小写粗体
\newcommand{\scalar}[1]{#1} % 标量:普通字体
% 示例
The weight matrix is $\mat{W} \in \mathbb{R}^{d \times k}$,
input vector $\vec{x}$ is multiplied by $\mat{W}$ to produce
$\vec{y} = \mat{W} \vec{x}$,where $\scalar{b}$ is the bias.
图表生成(Python / Matlab)
数据图脚本规范(每个图一个独立脚本):
# fig_generation.py
import matplotlib.pyplot as plt
import numpy as np
# 输出 PDF(矢量格式),避免光栅化
fig, ax = plt.subplots(figsize=(3.5, 2.5))
x = np.linspace(0, 10, 100)
ax.plot(x, np.sin(x), linewidth=1.5)
# 字号与正文匹配(10pt)
ax.tick_params(labelsize=9)
ax.set_xlabel(r'$\theta$ (rad)', fontsize=10)
ax.set_ylabel(r'$\sin(\theta)$', fontsize=10)
# 收紧边距
plt.tight_layout()
plt.savefig('fig_sine.pdf', dpi=300, bbox_inches='tight')
光栅化大数据图(当矢量太大时):
# 大数据量时对背景层做光栅化,线条保持矢量
from matplotlib.backends.backend_pdf import PdfPages
import matplotlib.pyplot as plt
fig, ax = plt.subplots(figsize=(3.5, 2.5))
ax.plot(x, y_large_dataset, rasterized=True, linewidth=0.5)
plt.savefig('fig_large.pdf', dpi=150)
图表格式优先级:PDF > SVG > PNG(按质量降序)
快速上手
本仓库无需安装,直接阅读即可:
# 克隆到本地
git clone https://github.com/Wookai/paper-tips-and-tricks.git
cd paper-tips-and-tricks
# 查看所有示例
ls examples/
# booktabs/ siunitx/ notation/ ...
# 本地预览 README
# 直接在 GitHub 上浏览,或用 Markdown 阅读器
建议工作流:在写某类内容(如表格)前,来此仓库搜索对应章节,复制示例代码到自己的 .tex 文件。
典型适用场景
| 场景 | 怎么用 |
|---|---|
| 首次写英文学术论文 | 从头到尾通读一遍,建立正确的排版直觉 |
| 写 camera-ready 版本前 | 逐条检查表格、图表、数字格式是否符合规范 |
| 导师吐槽格式问题 | 对照仓库里的正确示例,批量修复 LaTeX 代码 |
| 多作者合作写论文 | 将仓库的"一行一句"规则作为团队 LaTeX style guide |
| 制作答辩 PPT 配图 | 参考 Python/Matlab 图表规范,使风格与论文一致 |
坑与注意
- 仓库不活跃:最后一次 commit 在 2024 年(截至 2026-08-19),不代表最新 LaTeX 生态——siunitx / booktabs 本身仍在更新,但仓库未同步新版本语法。建议将仓库作为"理念参考"而非"最新 API 文档"。
- 偏向工科/数学论文:示例以 CS、EE、机器学习论文为主;人文社科、社会科学论文的 LaTeX 规范差异较大,直接套用需谨慎。
- 不覆盖内容写作:仓库只讲排版和图表,不涉及论文结构(Abstract / Related Work / Experiment 怎么写)——这部分要找专门的学术写作书籍。
- 部分链接失效:仓库中引用的 external guide 链接(如 ETH Zurich 的表格 PDF)可能已 404,建议用 Wayback Machine 备用。
- Matlab 示例较少:Python 示例较全,Matlab 示例相对稀缺,Matlab 用户需要更多参考 MathWorks 官方文档补充。
与同类对比
| 资源 | 类型 | 覆盖范围 | 语言 |
|---|---|---|---|
| Wookai/paper-tips-and-tricks | GitHub 经验仓库 | 排版+图表+符号,专注 LaTeX 细节 | 英文 |
| Chicago Manual of Style | 权威写作指南 | 语法+引用+格式,含在线版 | 英文 |
| 南大 LLM Paper模板 | LaTeX 模板 | 直接可用模板,非写作指引 | 中文 |
| Overleaf Blog | 在线教程 | LaTeX 入门+进阶,生态更广 | 英文 |
| 知乎/知乎专栏 | 社区经验 | 论文写作+排版,碎片化 | 中文 |
一句话总结:如果你刚开始用 LaTeX 写英文学术论文,或者导师反复吐槽格式问题,这本仓库是最高效的"格式急救手册";如果你需要完整的论文结构指导,还需要搭配专门的学术写作书或目标期刊的 author guidelines。
推荐结论
Wookai/paper-tips-and-tricks 是一个难得的研究团队经验沉淀——不是教科书式的规则罗列,而是"踩坑后总结的真实规范"。每个建议都有具体的 LaTeX 代码示例,可直接 copy-paste 到自己的论文里。建议将其作为团队 LaTeX style guide 的参考源,在写 camera-ready 版本前对照检查一次,至少能避免表格不专业、数字单位混乱、Git 合并冲突这三类高频问题。