更新日志： 2021-10-4：新增 书屋文档格式规范_1.0
一、基本要求
文档的内容应完整、有序、精炼。
文档采用国家正式公布实施的简化汉字，采用国家法定的计量单位。
文档中采用的术语、符号、代号等在全文中必须统一，并符合规范化的要求。文档中使用专业术语、缩略词应在首次出现时加以注释。外文专业术语、缩略词，应在首次出现的译文后用中文圆括号注明原词语全称。
文档中，除双引号使用「」外，其它标点符号全部使用一般中文符号。
文档非特别需要，均使用语雀 15 号，默认行高。
文档中一般不使用段首缩进。
文档字数应最好控制在 4000 字以内，如若有超出，也应不多于 10000 字。
二、文档规范
封面（可选）
使用语雀提供的尺寸比例的图片，图片类型不限，但最好可以表达出文档所述主题，或笔记作者想要传递的想法和观点。
书籍信息（根据书籍具体情况而定）
- 全书名。应是书籍的主标题和副标题（没有则省略），且需在书名上增加书籍在豆瓣上的链接。
- 原书名。是外文书籍的中文名，如若是中文书籍则省略。
- 作者名。书籍作者的名称，如是外国作者，则需加上国籍；如是中国作者，则可省略国籍的声明；如有多位作者，则应使用中文逗号隔开。
- 译者名。书籍的翻译人，如有多位译者，同样使用中文逗号隔开。
- 出版方。出版书籍的机构，包含出版方和出版社等，可同时存在。
- fISBN。国际标准书号，也是一本书的产品标识符。详细请百度了解 。
前言
- 中文摘要信息。中文摘要信息，内容应该简要，应包含本文的主要内容，或实际意义，或引导读者阅读，不宜使用公式、图表、图片、标注引用等，同时字数应控制在 100 字以内。
- 关键词。关键词应是可供检索使用的主题词条，应采用能覆盖文档主要内容的专业词条。关键词一般为 3~5 个，按词条的外延层次排列（外延大的排在前面），同时多个关键词以中文分号隔开。
摘要信息与关键词之间空一行。
目录
此处指使用语雀标题生成的文档大纲。目录（即语雀文档大纲）不宜过于复杂，一般最多为三级。一般不宜过长，一般不超过电脑 2/3 的高度（以自己电脑为参照）。
正文
行文要规范。
段首不缩进，段与段之间空一行（以目前语雀的使用规范而言）。
行文使用两端对齐。
标题字号以语雀 Markdown 语法为准，全部左对齐。
标题需要根据级别使用不同的序号，如「一、一级标题」、「（一） 二级标题」、「1. 三级标题」等。
在行文论述中，强调内容分为无色加粗、有色加粗、提示区块三种。
:::info :::info + 回车 :::
:::warning :::warning+ 回车 :::
:::success :::success+ 回车 :::
:::danger :::danger + 回车 :::
:::tips :::tips+ 回车 :::
在行文论述中，引用的文字需注明出处，同时在「附录-注释」中说明。
在行文论述中，如果是转载他人文章，或以他人文章作为参照编辑修改，亦须在标明出处，同时在「附录-版权声明」中进行说明。
结语
对于行文结束的说明，或展望，或告诫，或鼓励，或回顾，等等。
参考文献（可选）
参考文献按作者姓氏首字母顺序进行排列，同一作者的多篇文献按初版年排序。中英文参考文献需分开整理后进行排序。
参考文献的序号使用数字加方括号表示，每一篇参考文献最后以小圆点 .结束。
参考文献的主要作者只列姓名，不加有关于责任说明类的词语或文字。
参考文献的标识符号及格式参考百科。
附录
- 版权声明
版权声明示例1：
:::info 本文采用 知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议 (CC BY-NC-ND 4.0) 进行许可。 :::
版权声明示例2：
:::info 本文为某某平台作者「作者名」的原创文章，遵循CC 4.0 BY-SA版权协议，原文链接： :::
版权声明示例3：
:::info 本文为某某平台作者「作者名」的原创文章，已经转载后进行修改编辑，遵循CC 4.0 BY-SA版权协议，原文链接： :::
附件。可直接上传，可文字表述。
注释。对于文档中出现的术语、符号、代号、事件等的解释说明。
其它。如有其它不便于在其它项目板块放置的内容，也可归于此处。
致谢（可选）
语气可轻松愉悦，但需要保持敬重的态度，也不可严重离题。
致谢对象可包括：
- 协助完成工作和提供便利条件的组织或个人。
- 在工作当中提出建议和提供帮助的人。
- 给予转载和引用权的资料、图片、文献、研究思想和设想等的所有者。
- 其他可感谢的组织和个人。
- 身边的人。
其他
部分内容可不引用本规范，如诗歌、散文、歌词、英语等等。
其他未尽事宜，以规范美观为目的导向，适时更新本规范。
本规范文档参照 「玉祥」知识库文档格式规范指导_V1.2 制作。
若有收获，就点个赞吧
0 人点赞
