docs(workflow): 补全文档持续维护流程
This commit is contained in:
@@ -13,6 +13,12 @@ CraftKit 是面向 Codex 的通用插件工具集,覆盖软件开发、文档
|
||||
- [新项目初始化与应用拆分工作流](NEW-PROJECT-INITIALIZATION-AND-APPLICATION-SPLIT.md):适用于空目录、新仓库或尚未形成有效源码结构的项目。
|
||||
- [已有项目初始化与应用拆分工作流](EXISTING-PROJECT-INITIALIZATION-AND-APPLICATION-SPLIT.md):适用于已有源码、数据、接口和部署形态,需要基于现状渐进拆分的项目。
|
||||
|
||||
## 文档维护流程
|
||||
|
||||
CraftKit 按“初始化约定 → 创建或更新 → 审核生效 → 随实现持续维护 → 关闭时分类处置”管理项目文档。过程材料默认保存在本地任务目录;正式需求、生效设计、项目规范和长期知识保存审核状态,后续任务优先更新已有权威文档。
|
||||
|
||||
长期文档使用 `pending`、`approved`、`outdated` 表示待审核、当前有效和已知过期。任务关闭不结束文档维护;实现、接口、数据模型或业务行为变化时,需要检查并同步相关留存文档。详细规则由项目 `.craftkit/standards/document-maintenance.md` 维护。
|
||||
|
||||
## 插件组成
|
||||
|
||||
| 插件 | 用途 |
|
||||
@@ -31,20 +37,20 @@ CraftKit 是面向 Codex 的通用插件工具集,覆盖软件开发、文档
|
||||
|
||||
| Skill | 用途 |
|
||||
| --- | --- |
|
||||
| `plan-change` | 分析需求或问题的影响范围、依赖、风险和验证方式,形成可执行的变更计划。 |
|
||||
| `design-backend` | 设计后端模块边界、服务职责、事务、错误处理及数据影响。 |
|
||||
| `design-frontend` | 设计前端页面、路由、状态、交互、组件组合和数据流。 |
|
||||
| `design-api` | 设计或评审 HTTP API 的资源、方法、状态码和请求响应契约。 |
|
||||
| `design-db` | 设计或评审数据库表、约束、索引及变更与回滚方案。 |
|
||||
| `plan-change` | 分析影响范围并创建或更新可执行的变更计划,登记关联文档。 |
|
||||
| `design-backend` | 创建或更新后端设计,覆盖模块边界、事务、错误处理及数据影响。 |
|
||||
| `design-frontend` | 创建或更新前端设计,覆盖页面、路由、状态、交互和数据流。 |
|
||||
| `design-api` | 创建、更新或评审 HTTP API 契约,并维护其审核状态。 |
|
||||
| `design-db` | 创建、更新或评审数据设计及变更与回滚方案。 |
|
||||
| `design-frontend-data` | 设计前端请求边界、视图模型、状态所有权、缓存和并发处理。 |
|
||||
| `design-workflow` | 设计业务流程的任务、状态转换、权限、回退、撤回和审计规则。 |
|
||||
| `prepare-api` | 整理前后端接口清单、字段映射、类型转换、缺失项和联调风险。 |
|
||||
| `component` | 根据项目依赖和现有用法选择组件,查证 props、events 和 slots。 |
|
||||
| `form` | 设计或检查表单分组、布局、条件字段、错误展示和可访问性。 |
|
||||
| `style` | 根据项目视觉基线设计颜色、排版、间距、主题和响应式样式。 |
|
||||
| `implement-backend` | 按项目语言、框架和规范编写或修改后端代码。 |
|
||||
| `implement-frontend` | 按项目框架、组件契约和请求封装编写或修改前端代码。 |
|
||||
| `review-code` | 审查工作区、提交或分支变更中的正确性、兼容、安全、性能和测试问题。 |
|
||||
| `implement-backend` | 修改后端代码,并同步检查受影响的需求、设计、规范和知识。 |
|
||||
| `implement-frontend` | 修改前端代码,并同步检查受影响的需求、设计、规范和知识。 |
|
||||
| `review-code` | 审查代码质量,以及实现与当前有效文档的一致性。 |
|
||||
| `review-java` | 专项评审 Java 代码的资源管理、并发、异常和可维护性。 |
|
||||
| `review-mybatis` | 专项评审 Mapper、动态 SQL、参数映射、事务边界和查询性能。 |
|
||||
| `review-frontend` | 专项评审前端组件边界、状态、渲染、交互、可访问性和性能。 |
|
||||
@@ -64,8 +70,8 @@ CraftKit 是面向 Codex 的通用插件工具集,覆盖软件开发、文档
|
||||
| `md-to-docx` | 将 Markdown 转换为可编辑的 Word `.docx` 文档。 |
|
||||
| `xlsx-to-md` | 将 Excel `.xlsx` 工作簿按工作表转换为 Markdown 表格。 |
|
||||
| `format-md` | 修正 Markdown 的标题、空行、列表、代码块、表格和链接格式。 |
|
||||
| `archive` | 按明确规则复制、重命名、清理或拆分项目文档并生成报告。 |
|
||||
| `requirements` | 将技术说明、会议材料或问题描述整理成可确认的需求说明。 |
|
||||
| `archive` | 按明确规则归档历史快照,保留勘误和当前版本链接。 |
|
||||
| `requirements` | 创建或更新可审核的需求说明,避免产生冲突的平行文档。 |
|
||||
| `report` | 根据事实、Git 记录和任务状态撰写工作汇报或阶段总结。 |
|
||||
| `message` | 根据事件、受众和行动要求起草通知、提醒、确认或故障沟通消息。 |
|
||||
|
||||
@@ -88,11 +94,11 @@ CraftKit 是面向 Codex 的通用插件工具集,覆盖软件开发、文档
|
||||
|
||||
| Skill | 用途 |
|
||||
| --- | --- |
|
||||
| `init` | 初始化或更新项目的 `AGENTS.md` 与 `.craftkit/` 项目资料。 |
|
||||
| `document-output` | 查看或维护文档配置,登记任务文档,并在完成时预览沉淀、归档与清理。 |
|
||||
| `init` | 初始化或更新项目上下文、文档目录和持续维护约定。 |
|
||||
| `document-output` | 管理文档落盘、任务关联、审核状态、持续更新和关闭处置。 |
|
||||
| `handoff` | 生成可持续更新的任务交接文档和新任务接续提示词。 |
|
||||
| `distill` | 从任务证据中提炼可复用结论、决策和问题经验。 |
|
||||
| `lessons` | 初始化、维护和审计项目问题经验库。 |
|
||||
| `distill` | 从任务证据提炼知识,并更新、替代或标记已有结论。 |
|
||||
| `lessons` | 初始化、修订、标记过时和审计项目问题经验库。 |
|
||||
| `trace` | 复盘 Agent 的偏离、漏读或规则失效,并提出改进建议。 |
|
||||
| `worklog` | 根据指定日期、时区和作者的 Git 提交生成工作日志。 |
|
||||
|
||||
@@ -102,7 +108,7 @@ CraftKit 是面向 Codex 的通用插件工具集,覆盖软件开发、文档
|
||||
|
||||
| Skill | 用途 |
|
||||
| --- | --- |
|
||||
| `guidance` | 检索项目协作说明、项目资料和公共基线,返回可追溯的规则、冲突与缺口。 |
|
||||
| `guidance` | 检索当前有效的项目规则和知识,区分待审核、过时与历史材料。 |
|
||||
| `guidance-edit` | 建立、检查和维护 `.craftkit/standards/` 规范索引。 |
|
||||
|
||||
## 目录结构
|
||||
|
||||
Reference in New Issue
Block a user