Operating-document

标准文件发行格式

发行日期:2025年9月13日

文件编号:OPDOC-General-202501-R2-SC

前言

(有意留空)

修订记录

版本 时间 编者 描述
R1 2025.09.13 Yiheng Gui(5516) 初版
R2 2025.09.13 Yiheng Gui(5516) 扩写

第一章 标点符号

中英文标点的使用:

句号的使用:

但,在段落中遇到此句与下句之间,必须要使用 “。” / “.” 时。此时,可以使用

英文逗号的使用:

在遇到句与句之间要使用 “,” 分割时,需使用 , ,而不是 , 且 “,” 必须要紧贴左边的词,如下所示:

This is a word, and this is also a word

中英文括号的使用:

第二章 发行日期

日期分为中文和数字两个方案:

  1. 中文:

​ 以2025/1/1为例,使用中文书写时,如遇到月份/日期不满足2位,则不应进行补零,即以下日期为错误的:

​ 2025年01月01日、2025年01月1日、2025年1月01日……

  1. 数字:

    以2025/1/1为例,使用数字书写时,如遇到月份/日期不满足2位,则进行补零,即以下日期为错误的:

    2025.1.1、2025.01.1、2025.1.01……

第三章 文件编号

文件编号的格式为:

组织名-类别-本年度文件号-版本号-语言版本

以本文档文件编号:OPDOC-General-202501-R1-SC,为例

第四章 前言

前言部分应主要撰写:

当然,绝大多数情况都是写“(有意留空)”的

第五章 修订记录

修订记录就是本文件是干什么用途的?什么时候更新的?

用于明确该文档的责任人以及回溯

第六章 正文内容

得益于Markdown格式文件的优秀兼容性,我们暂且不需要在单个文件中添加“目录”

因此,在完成以上的二级标题:“前言”、“修订记录”后,即可直接撰写正文第一章的标题

推荐正文内容的二级标题加入“第x章”,以便于阅读

如在文中出现三级标题时,我们推荐加入”X.X”以便于阅读,例如:第七章的三级标题,可以是 ”7.1“ ;四级标题,可以是 ”7.1(1)“

第七章 后记与参考资料

7.1 后记

我们推荐:

在文章引用了许多参考资料后,不再编写后记

反则,如果没有参考资料,那我们推荐写后记,具体内容可以参考前言部分的内容,这里不再赘述

7.2 参考资料

参考资料的引用格式为:

[1] [名称](网址)
[2] [名称](网址)
......

后记

(有意留空)