Files
fire-safety-ymd/docs/project/README.md
2026-09-06 01:40:15 +08:00

52 lines
4.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# fire-safety-ymd 项目文档索引
本目录保存 fire-safety-ymd 专属知识。通用 AI-NSES 原文和模板保存在 `../import/reusable/`,不要在通用文件中写入本项目业务规则。
## 阅读入口
| 文档 | 用途 | 更新频率 |
| --- | --- | --- |
| [`../../AGENTS.md`](../../AGENTS.md) | Agent 工作方式、Go 规则和安全底线 | 低 |
| [`../../CONTEXT.md`](../../CONTEXT.md) | 项目目标、系统边界和技术栈 | 低 |
| [`../../PROJECT_STATE.md`](../../PROJECT_STATE.md) | 当前 checkpoint、风险和下一步 | 高 |
| [`ai-native-adoption.md`](ai-native-adoption.md) | AI-NSES 在本仓库的目录映射和采用状态 | 低 |
| [`ai-nses-project-overlay.md`](ai-nses-project-overlay.md) | fire-safety-ymd 对通用标准的项目覆盖规则 | 低 |
| [`backend-development-guidelines.md`](backend-development-guidelines.md) | Go 后端工程规范 | 低 |
| [`security-access-control-boundary.md`](security-access-control-boundary.md) | AI、MCP、数据库、身份和敏感数据边界 | 中 |
| [`integrations/superagent-openapi.md`](integrations/superagent-openapi.md) | SuperAgent Open API、Session、无 Trace/Trace SSE、恢复与探针说明 | 中 |
| [`integrations/superagent-mcp-spatial.md`](integrations/superagent-mcp-spatial.md) | SuperAgent 空间只读 MCP、配置、工具和联调门禁 | 高 |
| [`operations/postgis-srid-4326.md`](operations/postgis-srid-4326.md) | 已确认 WGS84 数据的 SRID 元数据迁移、验证与权限边界 | 高 |
| [`operations/nginx-public-entry.md`](operations/nginx-public-entry.md) | `agent.nianxx.com` 到 Go 页面、对话/MCP 的 HTTPS 反向代理示例 | 高 |
| [`operations/docker-test-deployment.md`](operations/docker-test-deployment.md) | `/home/firee-safety-ymd` 测试服务器的 Docker Compose、Nginx、验证与回滚手册 | 高 |
| [`../architecture/chat-api-v1.md`](../architecture/chat-api-v1.md) | 用户对话入口、内存 Session 映射、SSE 和三凭证边界 | 高 |
| [`../architecture/public-chat-entry-v1.md`](../architecture/public-chat-entry-v1.md) | DashScope 风格兼容入口、Nginx、会话映射与严格结果边界 | 高 |
| [`../specs/fire-safety-ymd-chat-page-v1.md`](../specs/fire-safety-ymd-chat-page-v1.md) | 默认关闭的 `/chat` 测试页面、同源兼容 SSE、Token 与会话边界 | 高 |
| [`../architecture/spatial-mcp-v1.md`](../architecture/spatial-mcp-v1.md) | MCP、Service、Repository 与 8 张 PostGIS 表的架构 | 中 |
| [`../workflows/user-chat.md`](../workflows/user-chat.md) | 首轮/多轮对话、失败处理和 curl 联调流程 | 高 |
| [`../workflows/exercise-plan-evidence.md`](../workflows/exercise-plan-evidence.md) | 从地名候选或演练点坐标查询方案证据的流程与能力边界 | 中 |
| [`../specs/fire-safety-ymd-chat-api-v1.md`](../specs/fire-safety-ymd-chat-api-v1.md) | 默认关闭的用户对话 API v1 可验收契约 | 高 |
| [`../specs/fire-safety-ymd-dashscope-compatible-chat-v1.md`](../specs/fire-safety-ymd-dashscope-compatible-chat-v1.md) | 既有 `completion` 客户端的受限兼容契约 | 高 |
| [`../specs/fire-safety-ymd-superagent-openapi-connectivity.md`](../specs/fire-safety-ymd-superagent-openapi-connectivity.md) | SuperAgent Open API 连通性基线 Spec | 中 |
| [`../specs/fire-safety-ymd-superagent-mcp-spatial-readonly-v1.md`](../specs/fire-safety-ymd-superagent-mcp-spatial-readonly-v1.md) | 空间只读 MCP v1 的可验收契约 | 高 |
| [`../import/db-samples/README.md`](../import/db-samples/README.md) | 本地 SQL 样例的敏感数据与禁止执行规则 | 中 |
## 通用 AI-NSES 资料
| 文档 | 用途 |
| --- | --- |
| [`../import/reusable/ai-native-software-engineering-standard.md`](../import/reusable/ai-native-software-engineering-standard.md) | 通用 AI-NSES 标准 |
| [`../import/reusable/general-development-guidelines.md`](../import/reusable/general-development-guidelines.md) | 跨项目开发协作规范 |
| [`../import/reusable/ai-native-templates/README.md`](../import/reusable/ai-native-templates/README.md) | ADR、Spec、Workflow、Handoff 等模板索引 |
## 后续文档目录
以下目录已在出现真实内容时建立;仍不创建空占位文件:
- `docs/domain/`:消防资源、火情位置、防火网格等稳定业务概念。
- `docs/architecture/`:已有用户对话、DashScope 风格公网兼容入口和空间 MCP v1;后续保存系统、数据、模块和部署架构。
- `docs/workflows/`:已有用户对话和演练方案证据查询流程;后续保存异常补偿流程。
- `docs/adr/`:不可逆或跨模块的重要决策。
- `docs/specs/`:可验收的功能规格;已有原生/兼容用户对话 API、受控测试页面、SuperAgent Open API 和空间只读 MCP Spec。
新增文档必须能回答“未来的新 Agent 为什么需要阅读它”,并从本索引或上级文档建立入口。