# 项目文档相关

本目录集中存放**文档、脚本、SQL、Excel 模板**等非业务代码资料，便于维护与备份。

**说明**：接口导出、工资导入等运行时生成的文件仍写入**仓库根目录**下的 `ExportFiles/`，与后端代码约定一致，不放在本目录内。

## 目录说明

| 子目录 | 用途 |
|--------|------|
| **docs/** | Markdown 文档：数据库说明、接口说明、工资规则、测试报告等 |
| **excel/** | Excel 模板、示例或离线数据表 |
| **scripts/** | Shell / Python 等辅助脚本（接口测试、数据生成等） |
| **scripts/sh/** | 以 **bash + curl** 为主的接口自测、联调脚本（命名多为 `test_*.sh`） |
| **scripts/test/** | 部分历史接口/导入测试脚本（与 **sh** 并列，新脚本优先放 **sh**） |
| **sql/** | 一次性或迁移类 SQL 脚本 |

### 前端工程内脚本

| 位置 | 用途 |
|------|------|
| **antis-ncc-admin/scripts/** | 管理后台本地启动等（如 `start-dev.sh`，依赖 nvm + Node 16.20.2） |

## 约定

- 新增同类资料请放入对应子目录；**勿在仓库根目录、`netcore/` 根下随意新增 `.sh`**，接口类测试统一放入 `scripts/sh/` 并在脚本头注释写明用法。
- 若出现新类型，可在本目录下再建子文件夹，并在此 README 中补充一行说明。
- 从仓库**根目录**执行脚本时，路径示例：`bash 项目文档相关/scripts/sh/test_xxx.sh`。