初始化交付包标准目录树:元数据README、节点说明与合同对齐规范

This commit is contained in:
yi
2026-10-13 09:29:06 +08:00
commit deb6fdc554
31 changed files with 203 additions and 0 deletions
+7
View File
@@ -0,0 +1,7 @@
# 真实交付产物(二进制/大文件)不入库,仅保留目录树模板与说明
*.zip
*.mp4
*.ts
*.m3u8
交付包实际产物/
!**/.gitkeep
+86
View File
@@ -0,0 +1,86 @@
# 开源软件改造交付包标准目录树
面向「开源项目改造 + 面板风格 UI + Docker 部署」外包交付的**标准交付包目录树模板**。
本仓库把交付要求固化为可直接导航的目录结构与节点说明,根 README 记录元数据并引用相关技能、合同规范与构建脚本。
## 元数据
| 项 | 值 |
| --- | --- |
| 名称 | panel-delivery-tree |
| 版本 | 1.0.0 |
| 标准依据 | 《开源软件改造部署外包服务合同》交付物与验收标准 |
| 创建日期 | 2026-10-10 |
| 维护组织 | depei |
| 机器可读元数据 | [`metadata.json`](./metadata.json) |
## 引用的技能与规范
| 资源 | 链接 / 路径 | 用途 |
| --- | --- | --- |
| 执行技能仓库 | [depei/panel-project-deploy](https://code.xinmi.cloud/depei/panel-project-deploy) | 18 步初始化、面板 UI 改造、Docker 部署工作流 |
| 合同交付规范 | 技能内 `references/delivery-contract.md` | 7 项交付物、7 条验收标准、痕迹清理与合规 |
| 面板 UI 规范 | 技能内 `references/panel-ui.md` | 科技感玻璃面板风格与对比度/浮层约束 |
| 交付包构建脚本 | 技能内 `scripts/build_delivery_package.py` | 解析 README 配图并自动收拢、打包、校验 |
| 交付物核查脚本 | 技能内 `scripts/deliverables_check.py` | 交付前阻断式核查(7 项交付物齐全性) |
| 面板 UI 审计脚本 | 技能内 `scripts/panel_ui_audit.py` | 阻断式视觉审计(0 violations 才放行) |
## 标准交付包目录树
```text
交付包模板/
├── README.md # 包根唯一一份:标准化商用 README(12 项必备内容)
├── docs/
│ └── screenshots/ # README 通过相对路径引用的配图(架构拓扑图/功能图)
├── 截图/
│ └── 界面截图/ # 改造后产品界面高清截图,按模块分组,全覆盖
│ ├── 首页/
│ ├── 园区态势/
│ ├── 监控大屏/
│ ├── 报警中心/
│ ├── AI对话/
│ ├── 系统管理/
│ └── 登录页/
├── 录屏/ # 全功能操作演示录屏 full-feature-demo.mp4
├── 文档/
│ ├── 环境依赖清单.md
│ └── 部署注意事项.md
├── docker/ # Docker 一键部署脚本/部署包(compose / Dockerfile 示例)
└── 网盘归档/
└── 归档清单.md # 百度网盘链接、提取码、有效期、目录结构
```
> 各节点目录内都有一份说明 `README.md`(交付时可删除或保留),描述该节点的内容与要求;
> 二进制产物(zip/mp4/ts/m3u8)已通过 [.gitignore](./.gitignore) 排除,本仓库只承载结构与规范。
## 七项交付物对照
1. 可稳定运行的完整项目源码 —— 随项目仓库交付(不在本模板内)
2. 改造前后高清界面对比截图 —— `截图/界面截图/`(全覆盖)
3. 全功能操作演示录屏 —— `录屏/full-feature-demo.mp4`
4. 网盘素材归档链接 —— `网盘归档/归档清单.md`
5. 标准化完整版 README —— 包根 `README.md`
6. Docker 一键部署脚本 —— `docker/`
7. 环境依赖清单 + 部署注意事项 —— `文档/`
## 如何用于一个真实项目
```bash
# 1. 在目标项目内用技能工作流完成改造、部署与面板 UI 审计(0 violations)
# 2. 用技能脚本构建真实交付包(README 配图会自动收拢、打包后自动校验)
python scripts/build_delivery_package.py \
--project-dir <项目目录> \
--readme README.md \
--out-dir .Codex/delivery
# 3. 交付前执行阻断式核查
python scripts/deliverables_check.py --project-dir <项目目录>
```
## 规范要点(合同对齐)
- README 必备 12 项:简介、功能(逐条配图)、痛点、技术优势、场景、目标人群、商业价值、
技术架构(含拓扑图)、环境依赖、快速开始、完整部署教程(优先 Docker 一键)、开源协议合规说明。
- 痕迹清理:清除第三方公司名/LOGO/水印/联系方式,但**保留 LICENSE 与法定版权声明**。
- 截图/录屏须清晰、完整、可溯源;录屏无卡顿、无黑屏、覆盖全功能。
- Docker 一键部署无故障;不支持 Docker 的手动步骤须 100% 可复现。
+27
View File
@@ -0,0 +1,27 @@
{
"name": "panel-delivery-tree",
"title": "开源软件改造交付包标准目录树",
"version": "1.0.0",
"standard": "contract-aligned",
"createdAt": "2026-10-10",
"owner": "depei",
"references": {
"skill_repo": "https://code.xinmi.cloud/depei/panel-project-deploy",
"build_script": "scripts/build_delivery_package.py",
"audit_script": "scripts/panel_ui_audit.py",
"deliverables_script": "scripts/deliverables_check.py",
"contract_ref": "references/delivery-contract.md",
"ui_ref": "references/panel-ui.md"
},
"deliverables": [
"可稳定运行的完整项目源码",
"改造前后高清界面对比截图",
"全功能操作演示录屏",
"网盘素材归档链接",
"标准化完整版README",
"Docker一键部署脚本",
"环境依赖清单与部署注意事项"
],
"acceptance_criteria_count": 7,
"tree_root": "交付包模板"
}
+14
View File
@@ -0,0 +1,14 @@
# 项目名称
> 本文件为交付包根目录唯一 README 的占位模板。交付时用项目标准化 README 替换,
> 必须包含合同约定的 12 项内容,并保证引用图片可在 `docs/` 下正常显示。
一句话项目简介……
## 功能(逐条对应截图)
## 行业痛点 / 技术优势 / 应用场景 / 目标人群 / 商业价值
## 技术架构(含框架拓扑图)
## 环境依赖
## 快速开始
## 安装部署教程(优先 Docker 一键部署)
## 开源协议合规说明
@@ -0,0 +1,2 @@
# 交付时替换为项目真实 Dockerfile
# FROM <base>
+3
View File
@@ -0,0 +1,3 @@
# Docker 一键部署
适配 Docker 的项目必须提供一键部署脚本/部署包;不适配的需提供书面说明。
@@ -0,0 +1,6 @@
# 交付时替换为项目真实 docker-compose.yml
# services:
# app:
# image: <image>
# ports:
# - "8080:80"
@@ -0,0 +1,4 @@
# README 引用配图
本目录存放根 README 通过相对路径引用的全部图片(架构拓扑图、功能配图等)。
`build_delivery_package.py` 会自动解析 README 中的图片引用并从项目中收拢到此处,解压即可显示。
View File
+5
View File
@@ -0,0 +1,5 @@
# 录屏
全功能操作演示录屏(建议命名 `full-feature-demo.mp4`)。
要求:无卡顿、无黑屏、声画清晰,完整演示所有功能模块。
mp4 为二进制不入库(见 .gitignore),交付时由构建脚本放入。
@@ -0,0 +1,3 @@
# AI对话
AI 对话与接口配置 的高清截图存放处。
@@ -0,0 +1,3 @@
# 界面截图
改造后的产品界面高清截图(中性命名,不体现版本对比或来源宣传),按模块分组,全覆盖无遗漏。
@@ -0,0 +1,3 @@
# 园区态势
园区实时态势、摄像头分布 的高清截图存放处。
@@ -0,0 +1,3 @@
# 报警中心
报警事件列表与详情 的高清截图存放处。
@@ -0,0 +1,3 @@
# 登录页
登录界面 的高清截图存放处。
@@ -0,0 +1,3 @@
# 监控大屏
多路监控墙、数据大屏 的高清截图存放处。
@@ -0,0 +1,3 @@
# 系统管理
地图/摄像头/规则/用户管理 的高清截图存放处。
@@ -0,0 +1,3 @@
# 首页
首页 / 仪表盘 / overview 的高清截图存放处。
+4
View File
@@ -0,0 +1,4 @@
# 文档
除根 README 外的交付说明文档:环境依赖清单与部署注意事项。
本目录不再放 README。
@@ -0,0 +1,7 @@
# 环境依赖清单
- 运行时:(如 Node 20 / MySQL 8 / JDK 17 / Python 3.11)
- 中间件:(Redis / RTMP 服务等)
- 硬件与资源:CPU / 内存 / 磁盘 / GPU(如需要)
- 第三方服务:(如 AI API、对象存储、地图服务)
- 版本与端口:
@@ -0,0 +1,7 @@
# 部署注意事项
- 必改的环境变量与密钥:
- 数据初始化与默认账号(账号来源需注明):
- 端口冲突与防火墙:
- 数据卷挂载与备份:
- 常见报错与排查:
@@ -0,0 +1,7 @@
# 网盘素材归档清单
- 网盘地址:<百度网盘链接>
- 提取码:
- 目录结构:截图/、录屏/
- 链接有效期:长期 / 永久
- 归档时间: