feat: 完成老项目文档化工作
- 新增 openspec-propose 技能,支持快速提案生成变更及相关文档。 - 新增接口汇总文档,整理后端接口及其用途。 - 新增页面功能说明文档,描述各页面的功能及路由。 - 新增项目总览文档,概述项目结构、技术栈及运行方式。 - 新增工具与非标准实现说明文档,记录项目中的特殊实现及约定。 - 创建 legacy-project-documentation 变更,整合现有文档并迁移至正式 OpenSpec 目录。 - 记录项目中的高风险历史实现特征,明确页面启用状态及接口调用关系。
This commit is contained in:
26
openspec/changes/legacy-project-documentation/proposal.md
Normal file
26
openspec/changes/legacy-project-documentation/proposal.md
Normal file
@@ -0,0 +1,26 @@
|
||||
## Why
|
||||
|
||||
这个仓库是一个已经完成开发的老项目,现有代码能够运行,但缺少可持续维护所需的项目文档与正式的 OpenSpec 变更资产。当前维护者需要同时理解路由、页面能力、接口分布、请求封装和历史遗留实现,如果继续在无文档状态下迭代,后续开发和排障成本会持续升高。
|
||||
|
||||
## What Changes
|
||||
|
||||
- 重新通过命令行初始化 OpenSpec CLI,并把当前仓库接入 GitHub Copilot 可识别的 OpenSpec 工作流。
|
||||
- 为现有 Vue 项目补齐开发文档,包括项目总览、页面功能说明、接口汇总和工具/约定说明。
|
||||
- 记录老项目中的关键历史实现特征,例如前端硬编码登录、axios 的下标式 baseURL 选择、请求参数风格混用等。
|
||||
- 明确哪些页面已启用、哪些页面存在代码但未接入路由或菜单,降低后续误判风险。
|
||||
|
||||
## Capabilities
|
||||
|
||||
### New Capabilities
|
||||
|
||||
- `project-documentation`: 为现有老项目提供结构化的维护文档,覆盖页面职责、接口来源、工具封装和后续维护注意事项。
|
||||
|
||||
### Modified Capabilities
|
||||
|
||||
- 无。
|
||||
|
||||
## Impact
|
||||
|
||||
- 影响目录:`.github/`、`openspec/`、`docs/`
|
||||
- 不影响目录:`src/`、`public/`、构建配置与运行逻辑
|
||||
- 影响对象:后续维护人员、接手开发人员、基于 GitHub Copilot/OpenSpec 的协作流程
|
||||
Reference in New Issue
Block a user