Update harness coding documentation templates

This commit is contained in:
QiuSW
2026-06-24 17:07:53 +08:00
parent d6c0e5b612
commit 2b4a842d7a
13 changed files with 189 additions and 79 deletions
+17 -5
View File
@@ -5,14 +5,16 @@
## 一、系统结构
按真实产品形态替换下图。项目可以是 Web、桌面、CLI、本地自动化、移动端、插件或多端组合,不要强行保留不存在的后端层。
```text
用户
|
v
前端 / 客户端
前端 / 客户端 / CLI / 本地工具
|
v
后端 API
后端 API / 本地核心模块
|
v
数据库 / 文件 / 第三方服务
@@ -22,8 +24,9 @@
- 前端:【框架、入口目录】
- 后端:【框架、入口文件】
- 本地工具:【CLI 入口、桌面入口、自动化脚本入口】
- 数据库:【类型、迁移方式】
- 外部服务:【支付、邮件、对象存储、AI 服务等】
- 外部服务:【邮件、对象存储、AI 服务、第三方平台等】
## 二、职责划分
@@ -40,6 +43,13 @@
- 【数据校验】
- 【异步任务 / 文件处理】
如果项目没有后端,删除本节或改为 **本地核心模块**:
- 【模块入口和公开函数】
- 【输入输出合约】
- 【文件读写 / 系统调用 / 第三方平台调用边界】
- 【错误处理和重试策略】
**数据库 / 存储**
- 【持久化哪些数据】
@@ -112,13 +122,15 @@ project/
按实际技术栈替换:
- `src/`:【前端 / 客户端代码】
- `server/`:【后端代码】
- `server/`:【后端代码;无后端项目可删除或替换为核心模块目录】
- `scripts/`:【数据校验、迁移、构建辅助脚本】
- `tests/`:【测试目录】
路径只是模板占位,初始化后必须按真实技术栈和项目形态替换,不要保留误导性的空目录说明。
## 七、架构纪律
- 业务事实和 schema 变化必须同步更新本文。
- 不在代码里发明文档没有的接口、字段和状态。
- 不把静态内容、用户数据、缓存数据混在一个模型里。
- 高风险模块先单独验证,再接入完整页面或流程。
- 高风险模块先单独验证,再接入完整页面或流程。