Files
opsxapi/docs/specs/_template.md
T
logan 9304b0e98c docs: AGENTS/SDD 对齐 Shell·DB,补架构页并清浏览器工作台口径
- 重写 AGENTS:浏览器只站+文档、操作走 ./run.sh gui;目录以现仓 src/src-tauri/server 为准
- docs/sdd-template.md 填成与 Shell/DB 同款短模板;sdd-agents/CLAUDE 指向它与 specs
- 新增 docs/architecture.md(两套壳、数据流、安全三底线)与 docs/README 索引
- HANDTEST/README 去掉用 :5173 当工作台的旧手测口径
2026-10-19 21:23:59 +08:00

3.2 KiB
Raw Blame History

SDD-<编号>:<功能名称>

按需填写;不适用项说明原因。先写第 1–2 节需求,再写设计;实现前确定第 7 节的场景和预期。占位符不代表已完成评审。

字段 内容
版本 / 变更级别 0.1 / S2 或 S3
设计状态 / 实现状态 Draft / Not Started
负责人 / 日期 待指定 / YYYY-MM-DD
关联需求 / 替代规格 待填写 / 无
批准版本 / 人 / 日期 / 依据 未批准

1. 现状、目标与范围

  • 当前行为与证据:<代码/配置/测试路径,区分事实和推测>
  • 用户角色与场景:<谁在什么条件下做什么>
  • 本次目标:<可观察结果>
  • 非目标及必须保留的行为:<明确边界>

2. 需求(不写实现)

  • FR-01:当 <条件> 时,系统必须 <行为>。
  • NFR-01:<指标、适用规模、测量方式;未知值标待确认,不编造>。
  • 涉及的权限、兼容、输入边界和异常场景:<说明>。

3. 架构与职责

<模块、所有权、依赖方向、复用点、关键流程;复杂交互按需附时序图。> <备选方案及选择理由;契约内可自主决定的实现细节。>

4. 接口、数据与配置契约

契约 权威文件/版本或本节定义 本次差异及兼容策略
HTTP / IPC / 事件 <路径、方法、请求、响应、错误码、校验、权限> <填写或不适用原因>
数据 / 配置 <字段、默认值、约束、持久化、迁移、锁文件> <填写或不适用原因>

<涉及任务时明确超时、取消、重试、幂等、并发和状态转换;涉及列表时明确分页/排序;避免重复抄写已有 Schema。>

5. UI 与交互(不适用则注明)

<入口、主要操作、保存/失败恢复、空/加载/错误/禁用状态。> <最小尺寸、全局分栏、滚动区域、长内容、亮暗主题、键盘可达性及国际化。>

6. 风险、安全与运行约束

失败/风险场景 防护、降级或恢复 日志/指标/可观察状态
<场景> <策略> <验证方式>

<权限、凭据、脱敏、执行目标、外部调用及数据保留按需填写;不得扩展产品未授权的审计/审批能力。>

7. 验收与验证证据

AC FR/NFR 给定/当/则(含明确预期) 设计章节/实现位置 测试或人工步骤 结果及证据
AC-01 FR-01 <正常场景> <实现前可待填> <用例/步骤> Not Run
AC-02 FR-01 <异常/边界场景> <实现前可待填> <用例/步骤> Not Run

<运行后填写命令、环境、日期、结果或证据链接;阻塞与跳过必须说明原因。>

8. 发布、迁移与恢复

<适用时:前置条件、备份、发布顺序、健康检查、兼容窗口、回退触发条件、恢复步骤和不可逆限制;S3 必填。>

9. 待决问题与变更记录

问题 影响/是否阻塞 负责人/结论依据
<问题或明确无> <影响> <依据>
日期/版本 旧→新差异、原因与影响 批准依据
YYYY-MM-DD / 0.1 初始草案 未批准