书写格式和风格
为了保证 HZNU Math Guide 内容的一致性、专业性与长期可维护性,所有参与协作的同学请遵循以下规范。
排版规范 (Typography)
- 行文空格:行文中,请在中文与英文、中文与数字、英文与数字之间增加一个半角空格(Space)。
- 链接空格:超链接与其前后的中文字符之间,请保持一个半角空格。
- 标点使用:
- 英文、数字紧接中文标点时,不需要增加空格。
- 中文引号统一使用直角引号「 」(内层使用 『 』),不再使用弯引号 “” 。
- 中文句子中出现的英文片段,原则上仍使用中文全角标点。
- 引用完整的英文句子、或专有名词中自带的标点,请保留英文原标点。
- 段落格式:正文段落开头请勿进行任何形式的空格缩进(保持顶格书写)。
- 专有名词:请严格遵守官方定义的大小写格式,例如
Kaggle、LaTeX、PyTorch、GitHub。
内容风格 (Style)
- 准确与严谨:书写内容应具有专业性,引用的数据、公式和结论需经过核实。
- 可读性优先:语言应清晰简洁,以「让读者快速理解」为核心目标,避免使用冗长或生僻的修辞。
- 批判性思考:我们不希望是单纯的内容搬运,鼓励在文档中加入个人的理解、对比分析及实际经验。
- 先进性校验:关注知识的更新周期。推荐资源时,请优先选择目前主流、活跃且具备前瞻性的内容。
GitHub 协作要求
- 提交规范:
- 请通过 Fork & Pull Request 的流程提交修改。
- 提交信息(Commit Message)应简要描述本次修改的内容。
- 文件结构:
- 图片等静态资源请统一存放在
/public/image/目录下。
- 图片等静态资源请统一存放在
数学公式
- LaTeX 标准:数学公式统一使用 LaTeX 语法。
- 行内公式(Inline):使用
$公式内容$。 - 块级公式(Display):使用
$$公式内容$$。
- 行内公式(Inline):使用
- 公式录入:为了保证文档的可搜索性,请优先使用文本格式录入公式。手写内容建议使用SimpleTex 转换为 LaTeX 代码。
- 手写笔记:若必须上传手写笔记(如复杂的推导过程),请确保字迹清晰,并以 PDF 或高分辨率图片格式作为附件链接。
长期维护
本规范并非一成不变。随着项目的推进,我们会根据实际协作中遇到的问题对本指南进行优化与补充。