本指南旨在帮助您更好地了解如何在社区文档中进行编写,确保内容的质量和一致性。

基本原则

  • 准确性:确保所有信息都是准确无误的。
  • 简洁性:用简洁明了的语言表达,避免冗余。
  • 一致性:遵循统一的格式和风格。

文档结构

  1. 标题:清晰、简洁,反映文档主题。
  2. 引言:简要介绍文档的目的和内容。
  3. 主体:详细阐述文档的主题,包括:
    • 概述:对主题进行简要介绍。
    • 详细内容:分点阐述,每点包含:
      • 标题:清晰表达该部分内容。
      • 正文:详细描述,可包含代码示例、截图等。
  4. 结论:总结文档要点,提出建议或展望。

语言风格

  • 客观性:避免主观臆断,用事实和数据说话。
  • 中立性:保持中立立场,不偏袒任何一方。

附加资源

欲了解更多关于社区文档编写的信息,请参阅社区文档编写教程

图片示例

下面是一张关于编写指南的图片:

Writing Guidelines