---
title: 元数据规则
navTitle: 规则
---
# 元数据规则

元数据规则说明 SuccApp 工作区中的元数据项目如何组织、存储、命名、选择文件类型和维护文件内容。直接新建或编辑元数据文件前，先用这些规则确认需求归类、文件类型、存放位置、格式规范、资源命名和引用路径。

阅读本节时，先理解如何从需求判断文件类型，再看文件新建和修改规范；需要进一步维护项目结构、文件格式和命名时，再阅读对应规则：

1. [根据需求判断文件类型](./choose-file-type.md)：从业务需求、开发任务或维护目标出发，选择文件大类和具体文件类型。
2. [文件新建和修改规范](./file-editing-rules.md)：了解新建、修改、移动、重命名元数据文件时需要先读哪些规范、如何校验差异。
3. [元数据文件存储](./storage.md)：了解生产环境数据库存储、AI 低代码开发本地工作区文件存储，以及两者同步时如何转换。
4. [元数据项目](./project.md)：了解项目用途、新建时机、项目目录结构规范，以及 `sysdata` 系统项目的特殊目录和风险。
5. [SuccApp Super JSON](./super-json.md)：了解 Super JSON 类文件的总体格式、主体结构、判别字段和直接编辑规则。
6. [资源引用与路径](./reference-paths.md)：了解外部资源引用、引用代号、相对路径、`referenceResources`、`targetPath`、`targetType` 和 `refType`。
7. [内嵌资源](./inner-resources.md)：了解 `innerResources` 如何把完整资源内容嵌入当前文件，以及它和外部资源引用的区别。
8. [命名约定](./naming-conventions.md)：了解文件名、目录名和后缀的基本规则。

!!! children !!!