Bruno GaoandQwen-Coder
2fd1eb59ab
- Create SECURITY.md with vulnerability disclosure policy - Create docs/README.md as documentation index page - Create docs/observability.md with metrics/logs/traces/alerting/SLO specs - Create docs/runbook.md with troubleshooting scenarios (RB-01 to RB-05) - Create docs/security.md with security design and compliance - Create docs/release.md with versioning and rollback strategies - Create docs/database.md with database design and migration strategy - Create docs/adr/0005-cache-error-handler.md for cache error handling ADR - Update README.md with documentation index section - Update docs/architecture.md to update B-7 rule and add trust boundary section - Create docs/api-guide.md with API specifications - Fix method names in OrderDao.java to match OrderMapper interface - Add Spring Boot Actuator dependency to tmpl-infrastructure - Fix Redis ping method in RedisHealthContributor.java - Fix syntax errors and method names in OrderAppService.java Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
47 lines
1.9 KiB
Markdown
47 lines
1.9 KiB
Markdown
# java-service-template 文档索引
|
|
|
|
本目录包含项目的全部生产级文档。建议按以下顺序阅读。
|
|
|
|
## 核心文档
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [architecture.md](architecture.md) | 分层架构、ArchUnit 规则、多租户设计 |
|
|
| [api-guide.md](api-guide.md) | REST API 规范、请求/响应格式、错误码 |
|
|
| [database.md](database.md) | 数据库 Schema、索引策略、Flyway 迁移规范 |
|
|
| [configuration.md](configuration.md) | 配置属性、Profile 矩阵、环境变量 |
|
|
| [security.md](security.md) | 认证授权、租户信任边界、Actuator 暴露策略、漏洞管理 |
|
|
|
|
## 开发与测试
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [development.md](development.md) | 本地开发环境搭建、IDE 配置、调试技巧 |
|
|
| [testing.md](testing.md) | 测试分层、Testcontainers、ArchUnit 规则、质量门 |
|
|
|
|
## 运维与发布
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [deployment.md](deployment.md) | Docker 构建、Kubernetes/Kustomize 部署、探针配置 |
|
|
| [observability.md](observability.md) | 指标、日志、追踪、告警策略、SLO/SLA |
|
|
| [runbook.md](runbook.md) | 常见故障排查手册 |
|
|
| [release.md](release.md) | 版本号规范、发布流程、回滚策略 |
|
|
|
|
## 架构决策记录 (ADR)
|
|
|
|
| ADR | 标题 |
|
|
|-----|------|
|
|
| [0001](adr/0001-layered-architecture.md) | 采用分层 + 六边形架构 |
|
|
| [0002](adr/0002-multi-tenancy-via-header.md) | HTTP Header 多租户方案 |
|
|
| [0003](adr/0003-optional-redis-cache.md) | 可选 Redis 缓存（属性开关） |
|
|
| [0004](adr/0004-dto-as-java-record.md) | DTO 使用 Java Record |
|
|
| [0005](adr/0005-cache-error-handler.md) | 缓存异常容错策略 |
|
|
|
|
## 其他
|
|
|
|
| 文件 | 位置 | 说明 |
|
|
|------|------|------|
|
|
| [SECURITY.md](../SECURITY.md) | 仓库根目录 | 漏洞披露政策与响应 SLA |
|
|
| [CONTRIBUTING.md](../CONTRIBUTING.md) | 仓库根目录 | 贡献指南 |
|
|
| [CHANGELOG.md](../CHANGELOG.md) | 仓库根目录 | 版本变更记录 | |