3.0 KiB
3.0 KiB
CaiWuXiTong 文档索引
本目录按“先启动、再协作、最后按业务深入”的顺序整理。文档中的规则发生冲突时,以根目录 AGENTS.md 和负责人最新明确要求为准;历史截图、聊天记录和临时排错方案不覆盖当前规则。
新电脑与本地开发
| 文档 | 用途 |
|---|---|
| 新电脑开发接续指南 | 在另一台 Windows 电脑克隆最新代码、启动本地环境、接入团队系统数据库并创建任务分支 |
| LOCAL_DEPLOY.md | 本地 Docker、临时引导库、共享系统数据库和常见命令的完整说明 |
| AGENTS.md | Git、协作、敏感信息、数据和部署边界 |
| DESIGN.md | VIP 黑金主题、组件和页面视觉规范 |
| SECURITY.md | 安全相关的最小基线 |
协作、构建与发布
| 文档 | 用途 |
|---|---|
| 开发与部署 SOP | 团队协作、Docker 构建缓存、服务器初始化、正式发布、镜像和回滚 |
| 团队协作说明 | 任务预检、分支、WIP PR、冲突协调和交付要求 |
生产发布只使用已经合并的最新 main,并遵守 SOP 中的授权、备份和回滚要求。服务器不构建源码,私有配置和证书不进入 Git。
上游数据、镜像与电商财务
| 文档 | 用途 |
|---|---|
| 通用上游数据接入 | 新来源发现、数据字典、固定只读查询、镜像登记和验收 |
| 上游业务镜像清单 | 当前来源、表/视图、镜像表和分阶段迁移状态 |
| 电商财务扩展开发说明 | 订单、结算、成本、资金和利润分析的业务模型与扩展边界 |
| 主体维度经营报表需求说明 | 主体维度经营报表的字段、口径、来源和验收契约 |
上游数据库按只读黑盒处理。正式页面优先读取共享业务镜像;尚未迁移的旧页面才使用兼容快照。不要在网页中接受任意 SQL,也不要把真实业务数据或连接凭据写进文档、测试和截图。
集成与模块参考
| 文档 | 用途 |
|---|---|
| 电子签约集成说明 | 电子签约集成的接口和配置边界 |
| OfflinePayments README | 离线支付模块说明 |
| PaypalStandard README | PayPal Standard 模块说明 |
| 测试数据说明 | 可公开共享的脱敏测试数据约定 |
文档维护约定
- 新增开发流程或交接信息时,优先更新本索引和对应主题文档,不在多个文件复制同一套命令。
- 命令、路径和页面名称以当前代码为准;改动后使用 git diff --check 检查格式。
- 密码、Token、数据库连接串、APP_KEY、.env、SSH 私钥、生产日志和真实财务数据永远不进入 Git。