28 lines
1.2 KiB
Markdown
28 lines
1.2 KiB
Markdown
# scripts 文档工具脚本入口
|
||
|
||
## 目录用途
|
||
|
||
`scripts/` 用于存放文档校验、导出、图表处理与治理辅助脚本。
|
||
|
||
## 常用脚本
|
||
|
||
- `doc-toolkit.sh`：文档创建/校验/导出工具
|
||
- `check-marksman.sh`：Marksman 环境检查
|
||
- `precommit-validate-markdown.sh`：提交前 Markdown 逐文件校验
|
||
- `process-mermaid.sh`：Mermaid 图表处理
|
||
- `unified_export.sh`、`quick_unified_export.sh`：统一导出
|
||
- `run-bank-transfer-smoke.sh`：调用 `sw-business-bank` 的 Java smoke CLI，对 Docker `SFTP/FTP` 测试容器执行上传/下载/哈希校验
|
||
|
||
## AI 治理脚本
|
||
|
||
- `check-ai-doc-governance.sh`：检查目录索引、主文档元数据与 AI 维护资产完整性
|
||
- `generate-archive-tag-index.sh`：生成 Archive 标签索引（来源、用途、可信级别）
|
||
- `ai-weekly-audit-diff.sh`：生成 AI 抽检差异清单（口径与编号差异）
|
||
|
||
## 使用建议
|
||
|
||
- 本地快速校验：`make validate-file FILE=<目标文件>`
|
||
- 跨文档校验：`make check-links`、`make validate-mermaid`
|
||
- 提交前演练：`pre-commit run --files <变更文件>`
|
||
- 文件通道 smoke：`scripts/run-bank-transfer-smoke.sh sftp` 或 `scripts/run-bank-transfer-smoke.sh ftp`
|