feat: 完成老项目文档化工作
- 新增 openspec-propose 技能,支持快速提案生成变更及相关文档。 - 新增接口汇总文档,整理后端接口及其用途。 - 新增页面功能说明文档,描述各页面的功能及路由。 - 新增项目总览文档,概述项目结构、技术栈及运行方式。 - 新增工具与非标准实现说明文档,记录项目中的特殊实现及约定。 - 创建 legacy-project-documentation 变更,整合现有文档并迁移至正式 OpenSpec 目录。 - 记录项目中的高风险历史实现特征,明确页面启用状态及接口调用关系。
This commit is contained in:
22
openspec/changes/legacy-project-documentation/tasks.md
Normal file
22
openspec/changes/legacy-project-documentation/tasks.md
Normal file
@@ -0,0 +1,22 @@
|
||||
## 1. OpenSpec 接入
|
||||
|
||||
- [x] 1.1 通过命令行在当前仓库重新初始化 OpenSpec CLI 资产
|
||||
- [x] 1.2 创建 `legacy-project-documentation` 正式 change
|
||||
- [x] 1.3 将旧 `spec/` 目录内容迁移并收敛到正式 `openspec/` 目录
|
||||
|
||||
## 2. 项目资料盘点
|
||||
|
||||
- [x] 2.1 梳理当前路由、菜单和页面启用状态
|
||||
- [x] 2.2 梳理主要接口分组、基础地址和调用页面
|
||||
- [x] 2.3 梳理 axios、fetch、jQuery.ajax、全局注入等工具约定
|
||||
|
||||
## 3. 文档输出
|
||||
|
||||
- [x] 3.1 输出项目总览文档
|
||||
- [x] 3.2 输出页面功能说明文档
|
||||
- [x] 3.3 输出接口汇总文档
|
||||
- [x] 3.4 输出工具与非标准实现说明文档
|
||||
|
||||
## 4. 规范校验
|
||||
|
||||
- [x] 4.1 运行 OpenSpec 校验并确认本次 change 结构可用
|
||||
Reference in New Issue
Block a user