优化竞品分析的文档结构
This commit is contained in:
@@ -72,7 +72,7 @@
|
||||
### spec-docs
|
||||
- **类型**: 基础设施
|
||||
- **能力**: 规范文档全生命周期管理 — 执行前检查是否需要创建/更新文档,周期审查文档与 changelog/代码的一致性(遗漏、陈旧、互斥检测),写入/更新规范文档
|
||||
- **触发场景**: "架构"、"重构"、"设计方案"、"交互规范"、"编码规范"、"审查文档"、"review docs"、"检查规范一致性"、周期自动审查(7天/30条changelog)
|
||||
- **输出**: docs/ 下 architecture/conventions/specs 子目录的规范文档、.opencode/data/spec-docs/state.json、审查报告
|
||||
- **触发场景**: "架构"、"重构"、"设计方案"、"交互规范"、"编码规范"、"审查文档"、"review docs"、"检查规范一致性"、"参考分析"、"竞品拆解"、"反拆"、"GDD"、"设计参考"、周期自动审查(7天/30条changelog)
|
||||
- **输出**: docs/ 下 architecture/conventions/specs/reference 子目录的规范文档、.opencode/data/spec-docs/state.json、审查报告
|
||||
- **路径**: .opencode/skills/spec-docs/SKILL.md
|
||||
- **备注**: 操作 B 具备 changelog 不可信假设与代码搜索 fallback 的互斥检测能力
|
||||
|
||||
@@ -16,7 +16,7 @@ description: >-
|
||||
|
||||
| 文件/目录 | 位置 | 用途 |
|
||||
|-----------|------|------|
|
||||
| `docs/` | 项目根 | 所有规范文档(architecture/conventions/specs) |
|
||||
| `docs/` | 项目根 | 所有规范文档(architecture/conventions/specs/reference) |
|
||||
| `docs/README.md` | 项目根 docs/ | 目录标准与使用规范 |
|
||||
| `state.json` | `.opencode/data/spec-docs/` | 周期审查状态追踪 |
|
||||
|
||||
@@ -43,7 +43,8 @@ description: >-
|
||||
|
||||
| 类别 | 关键词 |
|
||||
|------|--------|
|
||||
| 架构 | `架构`、`重构`、`分层`、`模块划分`、`技术选型`、`目录结构`、`核心依赖` |
|
||||
| `架构`、`重构`、`分层`、`模块划分`、`技术选型`、`目录结构`、`核心依赖`、`参考分析`、`竞品拆解`、`行业研究`、`反拆`、`GDD`、`设计参考` |
|
||||
| 方案 | `设计方案`、`设计系统`、`交互规范`、`UI规范`、`界面风格`、`数据流`、`API设计`、`部署方案` |
|
||||
| 方案 | `设计方案`、`设计系统`、`交互规范`、`UI规范`、`界面风格`、`数据流`、`API设计`、`部署方案` |
|
||||
| 规范 | `项目规范`、`编码规范`、`命名规范`、`约定`、`标准`、`编码风格`、`工作流` |
|
||||
|
||||
|
||||
@@ -10,7 +10,8 @@ docs/
|
||||
├── README.md # 本文件 — 目录标准与使用规范
|
||||
├── architecture/ # 架构级方案(分层、模块、技术选型、组件架构)
|
||||
├── conventions/ # 项目约定(编码规范、命名、Git 工作流)
|
||||
└── specs/ # 系统级技术规范(API 设计、数据模型、接口协议)
|
||||
├── specs/ # 系统级技术规范(API 设计、数据模型、接口协议)
|
||||
└── reference/ # 参考分析文档(竞品拆解、行业研究、设计参考)
|
||||
```
|
||||
|
||||
## 文档命名规范
|
||||
@@ -28,7 +29,7 @@ docs/
|
||||
---
|
||||
id: DOC-NNN
|
||||
title: 文档标题(中文)
|
||||
type: architecture | convention | spec
|
||||
type: architecture | convention | spec | reference
|
||||
status: draft | review | stable | deprecated
|
||||
created: YYYY-MM-DD
|
||||
updated: YYYY-MM-DD
|
||||
@@ -38,7 +39,7 @@ related_changelogs: [CL-xxx, CL-xxx]
|
||||
|
||||
字段说明:
|
||||
- `id`:与文件名编号一致
|
||||
- `type`:architecture(架构)、convention(规范)、spec(技术规范)
|
||||
- `type`:architecture(架构)、convention(规范)、spec(技术规范)、reference(参考分析)
|
||||
- `status`:draft(草稿)、review(审查中)、stable(已定稿)、deprecated(已废弃)
|
||||
- `related_changelogs`:关联的 changelog 锚点 ID 列表,用于溯因
|
||||
|
||||
@@ -54,6 +55,7 @@ related_changelogs: [CL-xxx, CL-xxx]
|
||||
| 调整了目录结构或模块划分 | 更新 architecture 文档 |
|
||||
| 设计或修改了 UI/交互标准 | 创建/更新 architecture 文档 |
|
||||
| 定义了 API 接口、数据模型、通信协议 | 创建/更新 specs 文档 |
|
||||
| 完成了竞品分析、行业调研、设计参考的深度研究 | 创建/更新 reference 文档 |
|
||||
| 约定被废弃或替换 | 标记为 deprecated,写明替代文档编号 |
|
||||
|
||||
## 更新与维护
|
||||
|
||||
Reference in New Issue
Block a user