本文档将向您介绍如何遵循我们的风格指南,以确保内容的一致性和专业性。
文档结构
引言
在撰写文档时,请确保遵循以下基本规则:
- 使用清晰、简洁的语言。
- 避免使用行话或专业术语,除非它们是必要的。
- 保持一致的风格和格式。
标题和子标题
使用标题和子标题来组织内容,使其易于阅读和理解。
- 使用
#
来创建一级标题。 - 使用
##
来创建二级标题。 - 使用
###
来创建三级标题。
列表
使用列表来展示信息,例如步骤或要点。
- 无序列表:使用
-
、*
或+
来创建。 - 有序列表:使用数字和句点来创建。
链接
使用链接来引用外部资源或内部文档。
- 内部链接:
[链接文本](/en/docs/other_guide)
- 外部链接:
[链接文本](https://www.example.com)
图片
使用图片来增强文档的可读性和吸引力。
- 示例:[]示例图片
代码示例
使用代码块来展示代码示例。
def hello_world():
print("Hello, world!")
引用和注释
使用引用和注释来提供额外的信息或解释。
- 引用:
[引用文本](https://www.example.com)
- 注释:
[注释文本](#注释)
请确保在撰写文档时遵循这些指南,以保持内容的质量和一致性。