Files
starRiverProperty/docs/AGENTS.md
T
反编译工作区 e8672a3c7b fix: relocate cwos-portal decompiled output to correct path; remove nested directory
Former-commit-id: dc30d42a8c55ed8b2382a41dc2434233fbed9930
2026-04-29 12:09:48 +08:00

2.5 KiB

docs/ — 文档中心

OVERVIEW

starRiverProperty 全仓文档集中地:架构说明、业务走查、构建环境、代码风格、运维脚本。原 dev-support/ 内容已迁入此处。

STRUCTURE

docs/
├── README.md                                      # 文档索引与当前排期
├── AGENTS.md                                      # ← 本文件
├── architecture/                                  # 工程结构
│   ├── Maven聚合工程说明.md                        # 5 个聚合工程定位
│   ├── 对外接口不变-远程调用与性能优化约定.md         # HTTP/Feign 契约约束
│   └── 对外接口不变-走查任务与状态.md               # 代码走查清单
├── business/                                      # 业务说明
│   ├── 访客注册与派梯楼层业务流程走查.md             # 访客派梯 Feign 调用链
│   └── 租户访客默认楼层技术产品方案.md               # 多租户默认楼层方案
├── build/                                         # 构建环境
│   └── ORIGINAL_BUILD_JDK.txt                     # JDK 8 依据
├── style/                                         # 代码风格
│   └── alibaba-eclipse-codestyle.xml              # P3C Eclipse Formatter
└── operations/                                    # 运维脚本
    └── deploy_cw_elevator_v1_lib_to_nexus.py      # V1 lib → Nexus

WHERE TO LOOK

Task Location Notes
当前迭代排期 README.md 前端跳过、后端优先的迭代范围
聚合工程关系 architecture/Maven聚合工程说明.md 模块依赖与工程定位
接口契约约束 architecture/对外接口不变-远程调用与性能优化约定.md 不可扩展的 HTTP/Feign 边界
走查任务清单 architecture/对外接口不变-走查任务与状态.md 可修正与须确认项
代码风格配置 style/alibaba-eclipse-codestyle.xml P3C 格式化 XML
JDK 版本依据 build/ORIGINAL_BUILD_JDK.txt JDK 8 强制依据
Nexus 上传 operations/deploy_cw_elevator_v1_lib_to_nexus.py V1 lib 批量部署

CONVENTIONS

  • 文档用中文撰写(README.md 及所有架构/业务文档)
  • docs/ 是文档唯一定位点,dev-support/ 已废弃
  • 格式化 XML 路径:所有 maven-*/pom.xmlalibaba.eclipse.codestyle.path 均指向 docs/style/
  • 运行 JAR 还原产物不在 docs/,而在 artifacts/decompiled/