跳转至

文档规范

适用范围:Hi-AIoT-Solution 项目内的文档包含基础文档和 README。

要求

文档规范以HiSpark社区文档下的《开源社区文档写作规范》为基准约束本项目的文档编写。 若与本项目实际不符,以本项目实际为准。

附加要求

  • 所有的 README.md 文件名都应该是大写字母,不能是 readme.md
  • 跨库 Markdown 链接原则
    • 尽量避免跨库链接的使用,确需使用时请使用网络 GitCode URL 链接。
    • 非跨库链接尽量使用本地相对地址,但应该确保在 GitCode 网页上和 HiSpark 文档上能够正确跳转。
    • 避免脆弱性引用的问题:
    • 链接不应该指向文件的具体行号,或者其他易变性的内容。
    • 允许指向 Markdown 文件的具体标题。
    • 多个子 README 的情况请使用单个 README 进行导航。

AI 创作文档要求

  1. 严格按照模板生成内容。
  2. 任何 AI 生成的内容都应该进行人工校对,确保内容的准确性。

内容写作

涉及 AI Skill、应用案例的 README.md 都应该参考本目录下的模板编写或修改,具体链接如下: