Files
panel-delivery-tree/README.md
T

6.6 KiB
Raw Blame History

开源软件改造交付包标准目录树

面向「开源项目改造 + 面板风格 UI + Docker 部署」外包交付的标准交付包目录树模板。 本仓库把交付要求固化为可直接导航的目录结构与节点说明,根 README 记录元数据并引用相关技能、合同规范与构建脚本。

元数据

项 值
名称 panel-delivery-tree
版本 1.0.0
标准依据 《开源软件改造部署外包服务合同》交付物与验收标准
创建日期 2026-10-10
维护组织 depei
机器可读元数据 metadata.json
交付登记 交付登记.md · registry.json
正式交付包 交付包/

交付包与 Git 地址登记

本仓库同时承担交付登记中心职责:保存每个项目的正式交付压缩包,并登记其 Git 地址与锁定提交。

当前已登记:

项目 交付包 Git 提交
智慧停车综合管理平台(绚丽增强层重交付) smart-parking-delivery-20261014.zip(28.82 MB)+解压目录(28 文件 / 28.83 MB) depei/smart-parking-platform 9421e62
智慧停车综合管理平台 smart-parking-delivery-20261010.zip(29.62 MB)+解压目录(28 文件 / 29.68 MB) depei/smart-parking-platform 3c99299

引用的技能与规范

资源 链接 / 路径 用途
执行技能仓库 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 才放行)

项目源码子模块

真实交付项目以子模块方式纳入(交付物第 1 项):

标准交付包目录树

# 交付包根(含项目源码子模块)
项目源码/
└── smart-parking-platform/   # git submodule → depei/smart-parking-platform @ 9421e62

# 交付物资产树
交付包模板/
├── README.md                     # 包根唯一一份:标准化商用 README(12 项必备内容)
├── docs/
│   └── screenshots/              # README 通过相对路径引用的配图(架构拓扑图/功能图)
├── 截图/
│   └── 界面截图/                 # 改造后产品界面高清截图,按模块分组,全覆盖
│       ├── 首页/
│       ├── 园区态势/
│       ├── 监控大屏/
│       ├── 报警中心/
│       ├── AI对话/
│       ├── 系统管理/
│       └── 登录页/
├── 录屏/                         # 全功能操作演示录屏 full-feature-demo.mp4
├── 文档/
│   ├── 环境依赖清单.md
│   └── 部署注意事项.md
├── docker/                       # Docker 一键部署脚本/部署包(compose / Dockerfile 示例)
└── 网盘归档/
    └── 归档清单.md               # 百度网盘链接、提取码、有效期、目录结构

各节点目录内都有一份说明 README.md(交付时可删除或保留),描述该节点的内容与要求。

真实交付的存档策略(压缩包 + 解压内容双存档):正式交付时,既把 zip 压缩包放入 交付包/,也把同名解压目录一并入库(README、截图、录屏 mp4、文档),便于整包下载的同时 直接在线浏览与增量检索。为此 .gitignore 对 交付包/** 下的 zip / mp4 显式放行; 交付包模板/ 中的二进制产物仍被排除,模板库只承载结构与规范。

七项交付物对照

  1. 可稳定运行的完整项目源码 —— 已以 git submodule 挂载于 项目源码/smart-parking-platform(见上表)
  2. 改造前后高清界面对比截图 —— 截图/界面截图/(全覆盖)
  3. 全功能操作演示录屏 —— 录屏/full-feature-demo.mp4
  4. 网盘素材归档链接 —— 网盘归档/归档清单.md
  5. 标准化完整版 README —— 包根 README.md
  6. Docker 一键部署脚本 —— docker/
  7. 环境依赖清单 + 部署注意事项 —— 文档/

如何用于一个真实项目

# 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% 可复现。