5.0 KiB
5.0 KiB
name, description, triggers, owner, group, version, updated
| name | description | triggers | owner | group | version | updated |
|---|---|---|---|---|---|---|
| 开发文档操控 | 操控采用「1~10 目录」的网站开发文档,实现调研、生成、更新、整合与复盘。每个网站项目可复制本 Skill 一份,将「开发文档路径」改为该项目路径即可按本能力操作该站开发文档。 | 开发文档操控/开发文档/1~10文档/网站开发文档/文档维护/开发文档维护 | 火炬 | 火 | 1.0 | 2026-02-17 |
开发文档操控(火炬)
用途:任一采用「开发文档 1~10」结构的网站项目,均可由本 Skill 操控其开发文档的全部工作内容。
用法:主仓库保留通用版;每个网站复制本 Skill 一份到该项目(如放开发文档/SKILL_开发文档操控.md),将下方「开发文档路径」改为该项目的开发文档根路径即可。
一、开发文档路径(复制到项目后必改)
通用版(主仓库):以卡若AI 官网为例,路径为:
开发文档根 = /Users/karuo/Documents/开发/3、自营项目/卡若ai网站/开发文档/
复制到某网站后:把「开发文档根」改为该网站仓库内的开发文档目录,例如:
开发文档根 = <该项目根>/开发文档/
所有下列步骤中的 开发文档/ 均指上述「开发文档根」。
二、标准结构(必须遵守)
- 根目录:仅保留一个
README.md,作为 1~10 索引入口;全部文档归入 10 个目录,根目录不散落其他文档。 - 1~10 目录:
1、需求|2、架构|3、原型|4、前端|5、接口|6、后端|7、数据库|8、部署|9、手册|10、项目管理。 - 入口文档:
README.md(1~10 索引)、1、需求/卡若AI项目使用说明.md或该项目等价总览、10、项目管理/开发文档使用指引(卡若交互式).md。 - 手册:
9、手册/使用手册(带图).md;配图放9、手册/images/。 - 复盘:迭代结尾用
10、项目管理/迭代复盘模板.md(卡若复盘格式)。
三、工作内容与操作(按本 Skill 执行)
3.1 调研
- 先读
开发文档/README.md与1、需求下项目使用说明(或业务需求、技术需求)。 - 明确本项目要做什么、给谁用、MVP 边界;无 1~10 则按本结构自建目录并补总览。
3.2 生成 / 更新
按 1~10 与「开发文档使用指引」逐项维护:
| 目录 | 工作内容 |
|---|---|
| 1、需求 | 业务需求、技术需求、成本、功能迭代记录、项目使用说明 |
| 2、架构 | 系统架构、技术选型、模块拆分、数据库概要 |
| 3、原型 | 原型设计规范、页面结构与流程、各页面线框描述 |
| 4、前端 | 前端规范、页面与路由、组件规格、毛玻璃与自适应、v0 融合与使用步骤、检查清单 |
| 5、接口 | 接口定义规范、API 清单、错误码与认证 |
| 6、后端 | 后端开发规范 |
| 7、数据库 | 数据库管理规范、数据设计 |
| 8、部署 | 部署方案与脚本、Next 等自动化部署流程 |
| 9、手册 | 使用手册(带图)、FAQ 详细、手册与落地方案提示词 |
| 10、项目管理 | 项目落地执行表、迭代复盘模板、前端任务细项、开发文档使用指引、前端实施记录等 |
前端子任务按 4、前端/前端开发流程(卡若式).md 与组件规格、检查清单执行;改需求/架构时同步更新接口、前后端、执行表(见使用指引 § 文档联动)。
3.3 整合与清理
- 整合:重复或可合并的文档并入对应目录(如多份提示词合并为一份),避免根目录散落。
- 清理:删除与本站无关、已废弃或已被合并的文件;保持 1~10 内文件与 README 索引一致。
3.4 验收与复盘
- 用
10、项目管理/项目落地执行表更新任务状态。 - 迭代结束用
10、项目管理/迭代复盘模板.md写复盘(卡若复盘格式);需要时更新1、需求/功能迭代记录。
四、执行顺序(卡若式)
- 先读:本 Skill +
开发文档/README.md+1、需求总览 + 本任务相关目录的「使用本页时」小节。 - 再做:按 §3 工作内容 调研 → 生成/更新 → 整合/清理 → 验收与复盘。
- 验证:结果是否与用户命令/目标一致;不一致则回溯、搜索、再执行直至达成或明确说明无法达成。
五、与全栈开发 Skill 的关系
- 全栈开发:负责官网/全站从需求到上线的整体流程,其中「开发文档」的操控规则与本 Skill 一致;全栈开发会引用 1~10 结构与本操控流程。
- 本 Skill:专注「开发文档」本身的维护与操作;每个网站复制一份并改路径后,即可确保该站开发文档按本能力被操作,无需每次从全栈开发里拆文档步骤。
复制到新网站后:仅改「开发文档路径」→ 即可按本 Skill 操控该站开发文档。