本文档旨在为开发者提供关于开发者门户(developer_portal)文档风格的指南。请确保遵循以下规则,以确保文档的统一性和专业性。

标题和格式

  • 标题层级:使用标题来组织文档内容,确保标题简洁明了。
  • 代码格式:使用代码块来展示代码示例,确保代码的可读性。

文档结构

以下是一个基本的文档结构示例:

  • 引言:简要介绍文档的目的和内容。
  • 术语表:列出文档中使用的专业术语及其定义。
  • API 参考:提供API的详细说明,包括参数、返回值等。
  • 示例:提供使用API的示例代码。

图片使用

在文档中使用图片时,请遵循以下规则:

  • 图片尺寸:确保图片尺寸适中,不影响阅读体验。
  • 图片质量:使用高质量的图片,确保图片清晰。

示例

<center><img src="https://cloud-image.ullrai.com/q/technology/" alt="technology"/></center>

链接

在文档中使用链接时,请遵循以下规则:

  • 链接格式:确保链接格式正确,避免出现错误。
  • 链接内容:确保链接内容与文档相关,避免误导读者。

示例

开发者门户

注意事项

  • 避免敏感内容:请确保文档内容不涉及黄、涉政等敏感内容。
  • 遵循政策:请确保文档内容符合大陆地区政策。

结语

遵循以上指南,可以帮助您创建出高质量、专业性的开发者门户文档。如果您有任何疑问,请随时联系我们。

开发者门户