战队文档规范
更新日期：2026/1/23
参与者：PickingChip
写作准则
编写高质量的技术文档应有一定写作准则，文档应该满足 3C 准则——清晰性（clearly）、简洁性（concisely）、一致性（consistently）。
- 清晰性：确保你的行文清晰而简单。
- 简洁性：在撰写任何文档时，知道该说多少是很重要的，不能少说也不可多说。
- 一致性：确保你在整个页面和多个页面中一致地使用相同的措辞。
编写前要考虑文档的目标受众，根据受众的不同调整文档的编写策略。例如希望其他组队友读懂的文档就要比面向组内的文档更加详细描述一些专业名词。
编写文档时要有分类意识，尽可能将联系性强的内容集中在同一部分，防止出现同一知识碎片化分布在全篇的情况。
编写文档时要有聚类意识，不同文档之间之间内容不要太相似，如果内容相近可以考虑合并，避免出现同一内容多篇介绍但每一页内容过少的情况。
文档的开篇需要标注上文档最近修改日期以及参与者等信息（格式与本文相同），来保证内容的有效性。
标题要求
- 文档使用的标题最多分四级。
- 下级标题不应该重复上一级标题的名字。
- 标题不能跨级，例如一级标题下不能直接出现三级标题。
- 尽量避免出现四级标题以防止章节过于复杂，第三级标题下并行的内容可以使用项目列表。
- 一级标题作为文章的标题只能有一个，二级标题是文章主要部分的大标题，三级标题是主要使用的末级标题。
文本要求
- 全角中文字符与半角英文字符之间，应有一个半角空格，全角中文字符与半角阿拉伯数字之间可以没有半角空格，但是上下文的格式应该统一。
- 要避免使用过长的句子，尽量使用简单句和并列句，能够肯定表达的意思就不要否定表达，避免使用双重否定句。
- 不要使用用非正式的语言，开玩笑或是玩梗用括号括起来，
要不然直接划掉。 - 段落应该有清楚的主题，中心句放在段首对全段内容进行概述。一个段落的长度不应过长。
- 使用代词时（比如“其”、“该”、“此”、“这”等词）确保只有一个含义，并在上下文中指明不要出现歧义。
符号要求
- 如果整句为英文，则该句使用英文/半角标点。
- 中文语句中的标点符号，均应该采取全角符号，这样可以与全角文字保持视觉的一致。
- 点号（句号、逗号、顿号、分号、冒号）不得出现在标题的末尾。
- 句子末尾用括号加注时，句号应在括号之外。