中文技术文档写作规范指南：清晰、准确、高效

一、标题等级与结构

技术文档的标题等级通常分为四级，分别是一级标题、二级标题、三级标题和四级标题。标题等级的划分应遵循一定的逻辑顺序，使文档结构清晰明了，便于读者理解和查找所需信息。

• **一级 一级标题用于表示文档的主要内容或章节，应簡潔扼要，概括該章或節的主要內容，應避免使用過多細節。

• **二级 二级标题用于表示一级标题下的分节或小节，应紧扣一级标题的内容，详细阐述相关的内容或要点。

• **三级 三级标题用于表示二级标题下的进一步细分，应更加具体和深入，进一步阐述相关的内容或要点。

• **四级 四级标题用于表示三级标题下的进一步细分，应尽可能具体和详细，通常用于列举要点或示例。

标题等级使用规范

• 一级标题下不能直接出现三级标题，必须先有二级标题。
• 标题要避免孤立编号（即同级标题只有一个）。
• 下级标题不重复上一级标题的名字，应使用新的表述或角度。
• 标题应簡潔扼要，不能太長或太短，一般以 20 個字以內為宜。
• 标题应突出重點，吸引讀者注意，使讀者能快速了解該章或節的主要內容。
• 标题应一致，即同級標題應採用一致的格式和字體大小。
• 标题应對應內容，即標題應准确反映該章或節的內容，不能出現標題與內容不符的情況。

二、正文写作规范

1. 语言规范

• 语言应简明扼要，避免使用含糊不清或模棱两可的语言。
• 避免使用生僻或晦涩的专业术语，若必须使用，应在首次出现时给予解释。
• 避免使用冗长或复杂的句子，使句子簡潔明了，易於理解。
• 避免使用過多形容詞或副詞，以免分散讀者的注意力。
• 使用一致的語氣和語調，保持文章的連貫性和一致性。

2. 语法规范

• 遵循正确的语法规则，避免出现语法错误。
• 句子应结构完整，主语、谓语、宾语等成分齐全。
• 标点符号应正确使用，符合汉语标点符号使用规范。

3. 格式规范

• 段落应分明，每段应有明确的主题或内容，段落与段落之间应有合理的间距。
• 使用适当的字体和字号，使文字清晰易读。
• 使用合适的页边距和行距，使页面布局美观大方。
• 使用适当的标题和副标题，使文章结构清晰明了。
• 使用列表或表格来组织和呈现数据或信息，使内容更加直观易懂。

三、插图和表格的使用规范

• 插图和表格应与正文内容相关，有助于读者理解内容。
• 插图和表格应清晰美观，易于辨认。
• 插图和表格应有合适的标题和注释，帮助读者理解其内容和含义。
• 插图和表格应正确编号，便于读者引用和查找。
• 插图和表格应放在适当的位置，以便读者在阅读正文时能够及时看到。

四、参考文献的引用规范

• 参考文献应真实可靠，与正文内容相关。
• 参考文献应在正文中以适当的方式引用，并列出完整的参考文献信息。
• 参考文献的格式应遵循统一的标准，如 GB/T 7714-2015 《文后参考文献著录规则》。

五、版权和许可声明

• 技术文档应包含版权和许可声明，以保护作者的权益。
• 版权声明应包括作者姓名、创作日期和版权声明。
• 许可声明应包括文档的使用条款和条件。