以下是社区官方文档编写和管理的最佳实践,帮助您更好地理解并遵循我们的规范。
语言风格
- 中文:默认情况下,文档采用中文编写。
- 英文:如果您访问的是 /en/xxx 路径,文档将使用英文。
内容结构
- 标题:使用清晰的标题来组织文档内容。
- 列表:使用列表来展示步骤或要点,提高可读性。
- 链接:使用链接引导读者深入了解相关主题。
示例
以下是一个简单的示例:
标题示例
- 一级标题:用于文档的主标题。
- 二级标题:用于文档的子标题。
列表示例
- 使用
-
或*
创建无序列表。 - 使用
1.
,2.
,3.
创建有序列表。
链接示例
- 使用
[链接文本](/path/to/page)
创建内部链接。
图片示例
以下是关于“Golden Retriever”的图片示例:
注意事项
- 避免敏感内容:请确保文档内容不包含涉黄、涉政等敏感信息。
- 尊重版权:请确保使用图片等资源时尊重版权。
更多信息
如需了解更多关于社区官方文档的信息,请访问 社区官方文档首页。
**请注意**:以上内容仅为示例,实际文档内容需根据具体情况进行调整。