文档撰写规范
来自TJUUSWiki
导言
文档撰写规范用于展示UnionWiki各类文章、条目的撰写要求，以便于作者对照安排撰写对象的结构、内容等。
百科类条目
百科类条目，指为介绍某个对象，而撰写的能够使读者阅读后能够了解该对象属性、内容等的条目。
UnionWiki的百科类条目，在安排上有以下要求：
- 中立性：内容必须以中立的观点撰写，平等地呈现所有重要的、已发表的观点，不得将某一观点当作事实呈现。
- 可验证性：所有事实性陈述和重要观点必须提供可靠的来源进行支撑（即提供脚注或参考文献）。
- 非原创性：不得在条目中提出未经可靠来源发表的、新的理论、数据、结论或观点。
在行文上有以下要求：
- 导言：必须在条目开头用一至两段文字简洁地概括条目主题，包括“是什么”、“有什么用”，并包含所有必要的定义。导言应包含条目的全称，并用粗体标示主题名称。
- 主要内容：逻辑上应划分为清晰的章节和子章节。
- 结尾部分：包含“参见”（相关条目）、“参考文献”和“外部链接”等标准章节。
不符合以上要求的百科类条目，将会被标注提醒修订。
教程类文章
教程类文章，指出于某个特定目的，而撰写的能够使读者阅读后能够成功完成该目的的文章。
UnionWiki的教程类文章，在安排上有以下要求：
- 节点：也就是知识点，是知识学习中的不可分割的最小整体。每个节点都有明确的读者画像、预备知识（必须先掌握的其他节点，也叫前置知识）以及内容范围。一个节点可以是一篇文章，也可以是较长文章的一部分。
- 知识树：节点间通过预备知识有向连接形成知识树。知识树可代替传统教材的目录，鼓励按需学习而不是按目录顺序学习。鼓励每个节点只有需要时再学。
- 自洽：如果一篇文章的内容是自洽的，就意味着除了列出的预备知识外不需要其他其他材料就可以理解该文章。
- 多版本：同一个内容做不同版本的文章满足不同读者的需求，即使有大部分重复内容。
- 封装和分离（可选）：考虑模块分割时，尽量把 “是什么”、“有什么用”、“怎么用”、“为什么” 划分为不同的节点，即使这些节点处于同一篇文章中。这是为了进一步避免想学习前者的读者接触到不需要的内容。
- 特殊到一般（可选）：倾向具体的例子、然后倾向特殊范围的定义、最后才给出更一般化的定义。
不符合以上要求的教程类文章，将会被标注提醒修订。
