Files
UserhomeService/.workbuddy/skills/java-backend-doc-maintainer/SKILL.md
T
2026-08-21 09:37:21 +08:00

3.9 KiB
Raw Blame History

name, description, agent_created
name description agent_created
java-backend-doc-maintainer 项目级 skill(由全局 java-backend-doc-maintainer 在用户手动启用本工程时写入)。在本 Spring Boot 工程内:新增/重命名/删除 .java 源文件时自动同步 后端文件速查表.md;发生重大功能变化或用户手动输出 "更新后端项目知识库" 时更新 后端项目知识库.md。仅在当前工程生效,打开其他工程不会触发。 true

Java 后端文档维护(项目级自动维护)

本 skill 由全局 java-backend-doc-maintainer 在用户于本工程手动触发时写入,仅对当前 Spring Boot 工程生效。生效后:文件增删改自动维护文档,无需每次手动。

两份文档与触发时机

文档 位置 触发
后端文件速查表.md 工程根(pom.xml 同级) 本工程内新增 / 重命名 / 删除 .java 时自动同步;或用户手动输出 "更新后端文件速查表" 全量重建
后端项目知识库.md 同上 重大功能变化时更新;或用户手动输出 "更新后端项目知识库" 强制梳理

工程根目录

即本 skill 所在工程的 pom.xml 同级目录(已激活,无需再向上查找)。

一、后端文件速查表.md(文件级索引)

维护触发:本工程内新增 / 重命名 / 删除 一个 .java 源文件(src/main/java 或 src/test/java)时立即同步;纯内容改动(不改文件名/路径)不触发。

内容结构(保持表格,按层分组):

  • 顶部:工程名、基础包、最近更新时间、维护规则。
  • 分组表(每组一个二级标题):Controller / Service / Repository / Entity·Model / DTO·VO·Request / Config / Common(aspect、annotation、util、interceptor、listener)/ 其他(task、event、enums)。
  • 每行字段:路径(相对工程根) | 类名 | 职责(一句话) | 关键关联(如关联实体、对外接口、调用的服务)。
  • 重命名:更新该行路径与类名,并在表末"变更记录"追加(旧路径 → 新路径,时间)。
  • 删除:移除该行,变更记录追加"删除 路径 时间"。
  • 新增:插入对应分组,变更记录追加"新增 路径 时间"。
  • 若文件缺失,从 references/backend-file-index.template.md 复制骨架,先全量扫描现有源码再填,不要留空。

二、后端项目知识库.md(架构 / 功能 / 约定)

维护触发(满足任一即更新):

  1. 用户手动输出 "更新后端项目知识库"(最高优先,立即全量梳理)。
  2. 发生重大功能变化:新增业务模块 / 领域、新增一组对外 API、引入新中间件或外部系统对接、核心流程 / 权限模型 / 数据模型重大调整、技术栈版本迁移。判断标准:影响"系统由哪些部分组成、如何协作、有哪些约定"的变化;普通 bug 修复、单文件小改不触发。

内容结构见 references/backend-knowledge.template.md:

  • 项目概览(定位、技术栈版本、运行方式)
  • 模块 / 包结构(各层职责)
  • 核心领域模型与关系(逻辑外键请注明)
  • 关键业务流程
  • 工程约定与模式(异常返回结构、鉴权、CORS、缓存、事务边界等——只记录真实存在的,不臆造)
  • 集成点(DB / Redis / MQ / Nacos / SSO-CAS / 外部 API,写用途不写密钥)
  • 重要设计决策与原因
  • 待办 / 已知坑

若文件缺失,从 references/backend-knowledge.template.md 复制骨架再填。

反幻觉与纪律

  • 维护前用 Glob / Grep / Read 核实文件真实存在、类名真实、职责真实。
  • 不因为"应该长这样"而编造;不确定就标注"待核实"。
  • 两份文件保持可机器读取的表格 / 标题结构,方便后续 AI 速查。
  • 不写入密钥、密码、token;bootstrap.yml / application.yml 等未经授权不改动,仅给诊断建议。