# TCP2UART 项目文档索引

本文档用于说明当前仓库中应长期维护的项目文档，以及已合并或删除的过时资料归属。

## 当前有效文档

| 文档 | 用途 | 阅读时机 |
|------|------|----------|
| `项目需求说明.md` | 需求源头，定义硬件边界、软件边界、最终协议模型和验收口径 | 立项、需求确认、验收前 |
| `AT固件使用手册.md` | 对外 AT 协议和 MUX 帧使用说明 | 上位机开发、联调、测试脚本编写 |
| `项目技术实现.md` | 内部实现口径，说明配置模型、路由层、TCP 背压和网络链路策略 | 修改固件架构或核心逻辑前 |
| `代码结构与阅读指南.md` | 代码目录、主流程、模块职责和推荐阅读路径 | 新成员接手、代码审查、定位问题前 |
| `工程调试指南.md` | 实机 bring-up、串口、CH390、lwIP、TCP/UART 通路调试步骤 | 现场调试、故障复现、回归验证 |
| `CH390_最终结论报告.md` | CH390 阶段性硬件/软件排障结论归档 | 遇到 CH390 低层异常时回看历史结论 |

## 非项目叙述文档

| 文件 | 说明 |
|------|------|
| `Reference/stm32f103r8.pdf` | STM32F103R8 参考资料 |
| `Reference/CH390DS1.PDF` | CH390D 数据手册 |
| `TCP2UART.ioc` | STM32CubeMX 外设、时钟、DMA、引脚配置源 |
| `MDK-ARM/TCP2UART.uvprojx` | Keil MDK 主工程文件 |
| `CMakeLists.txt`、`cmake/stm32cubemx/CMakeLists.txt` | CMake 工程入口与源码/包含路径清单 |

## 已合并或删除的过时资料

以下文件不再作为长期文档维护：

| 原文件 | 处理方式 | 原因 |
|--------|----------|------|
| `项目计划.md` | 删除 | 早期计划仍以 FreeRTOS、socket/netconn 为目标，已与当前 bare-metal + lwIP RAW 实现不一致 |
| `uart-ch390-debug-handoff.md` | 删除并将有效结论并入 `工程调试指南.md` | 阶段性调试交接记录，包含旧 AT 命令、旧换行口径和历史测试现场信息 |
| `Keil工程配置说明.txt` | 删除并将有效构建入口并入本索引和 `代码结构与阅读指南.md` | 手工配置清单包含旧 FreeRTOS/sys_arch 路径，容易误导当前工程维护 |
| `uv4_stdout.txt` | 删除 | 构建输出日志，不属于长期项目文档 |
| `MDK-ARM/build_capture.txt` | 删除 | 构建捕获日志，不属于长期项目文档 |
| `MDK-ARM/keil-build-viewer-record.txt` | 删除 | 构建查看器记录文件，不属于长期项目文档 |

## 文档维护原则

1. 对外协议只在 `AT固件使用手册.md` 中完整展开；其他文档只引用核心约束，避免重复维护。
2. 需求和实现统一使用 `MUX / NET / LINK` 三层模型。
3. `LINK[idx]` 是内部配置数组模型，`S1/S2/C1/C2` 是 AT 命令中使用的对外角色名。
4. 调试现场日志只在仍有长期诊断价值时整理进 `工程调试指南.md` 或 `CH390_最终结论报告.md`，不要直接保留临时 handoff/log 文件。
5. 构建结果、IDE 输出、串口抓包原始记录应放入未纳入长期文档的 artifacts/logs 位置，避免污染项目根目录。