文案排版规范指北指北
GitHub - sparanoid/chinese-copywriting-guidelines
統一中文文案、排版的相關用法,降低團隊成員之間的溝通成本,增強網站氣質。
连享会推文写作指南
我在参与连享会推文撰写的过程中,发现在连享会助教团队资料的成员手册中,连享会推文写作指南非常具有参考与实践价值,因此希望将这份指南的部分内容分享出来,如果涉及侵权请留言让我删除。以下为写作指南中关于格式要求部分的内容:
推文格式要求
特别注意: 除非万不得已,尽量 不要 用图片形式展示 Stata 结果。推文中的 Stata 结果尽量采用结果窗口中呈现的文本信息来呈现,也就是采用代码块来呈现估计结果。这样就不会过度依赖图床,图床一旦出问题,就会导致推文中的所有图片都无法正常显示。另外,使用文本块显示结果可以获得更好的跨平台展示效果。
范本:「简化版范例」和「完整版范例」(单击页面中的【编辑】按钮查看原始 Markdown 文档)。
- 署名: 请在推文首行填入你的真实姓名 (单位信息),格式为
> 张三丰 (xxx大学),邮箱 - 标题和层级:
- 推文的各个小节需要顺序编号
- 一级标题用 「
## 1. 一级标题」 (说明:##后要添加一个空格) - 二级标题用 「
### 1.1 二级标题」,最多用到三级标题,即「#### 1.1.1 三级标题」。 - 如果后续还需细分,可以用 条目(item) 或独占一行的粗体文字代替。这主要是因为,多数 Markdown 编辑器的一级标题字号都太大了。
- 段落: 段落之间要空一行,这样网页上的显示效果比较好;每个段落不要太长 (最好不好超过 200 字,4 行以内比较好),否则网页或手机阅读时会比较累;
- 中英文混排:
- 记得加空格!! 英文字符和数字两侧要空一格,否则中英文混排时字符间距过小;例如:
我用Stata已经15年了(Cox,2019),但Arlion(2018)说他刚用了14年。要修改为:我用 Stata 已经 15 年了 (Cox, 2019),但 Arlion (2018) 说他刚用了 14 年。。 - 括号的使用 文中所有圆括号都要在半角模式下输入,
(左侧和)右侧各添加一个空格。中英文混排格式参见上一行里的例子。
- Stata 相关
- Stata 要写为 「Stata」(首字母大写,无需加粗),不要写成 「stata」或「STATA」。
- 变量名用粗体 (如 **varname** → varname);
- Stata 命令用高亮显示 (如 `regress` →
regress); - 多行 Stata 命令和结果展示使用 代码块样式,即使用首尾 **```** 包围,首行为 「```stata」,尾行为「```」。
- 特别注意: 除非万不得已,尽量不要用图片形式展示 Stata 结果。推文中的 Stata 结果尽量采用结果窗口中呈现的文本信息来呈现,也就是采用代码块来呈现估计结果。这样就不会过度依赖图床,图床一旦出问题,就会导致推文中的所有图片都无法正常显示。另外,使用文本块显示结果可以获得更好的跨平台展示效果。
- 数学公式:
- (1) 单行公式: 用 $$math$$ 包围的单行数学公式上下各空一行,以保证公式和正文之间的段落间距合理。
- (2) 行内公式: 可以使用 $math$ 包围。为了保证在知乎,简书和码云中都能正常显示公式,请把 $y=x\beta$ 写成
$y=x\beta$,而不要写成$ y=x\beta $(内侧多加了两个空格)。 - (3) mathpix 神器 - 惊喜: 无论是网页还是 PDF 中的数学公式,都可以使用 mathpix (https://mathpix.com/) 软件扫描后识别成 LaTeX 数学公式,非常快捷。参见 神器-数学公式识别工具 mathpix。本页面顶端的「连享会成员工具包」中提供该软件的下载。
- 图片:
- (1) 务必使用 lianxh.cn 的图床,参见第 2 小节 - 「2. 设定 PicGo 图床」。
- (2) 图片的命令规则:作者姓名_推文关键词_Figxx.png/jpg,例如:连玉君_面板数据一文读懂_Fig01.png。由于我们所有人的图片都放置在同一个图床,若图片名称过于简单,会导致图传里面有很多重名的文件,引用的时候就会出错。
- 版权和引用: 推文若为英文翻译稿,请务必在文首注明来源(独占一行)。Markdown 格式为:「
**Source:** [原英文文献完整信息](网址)」,显示效果为「Source:原英文文献完整信息」。文中若有从别处复制粘贴而来的内容,要标明出处。 - 底部文本: 推文底部的文字介绍无需添加,在修改完后会由总编统一添加。