SuperAPI AI 工具集

semantic-docs

编程与开发

查看项目

更新于 10-20 17:12

技能介绍

用途

semantic-docs 用于浏览 docs/semantic/ 目录下的语义化文档,这些文档用于把业务逻辑映射到 Drupal 代码。它适合在以下情况使用:需要查询某个功能如何实现、某条业务规则位于哪里、某个实体的字段结构,或者某个用户故事涉及哪些代码。

主要能力

该技能提供以下脚本:

  • 按 Logic ID 查找:$SKILL_DIR/scripts/find-logic-id.sh AUTH-L2,返回代码位置、文件路径、复杂度。
  • 按功能查找:$SKILL_DIR/scripts/find-feature.sh ACCS,返回完整技术规格。
  • 按实体查找模式:$SKILL_DIR/scripts/find-entity.sh user,返回包含字段和关系的 JSON 模式。
  • 按用户故事查找:$SKILL_DIR/scripts/find-user-story.sh US-004,返回用户故事及其关联的 Logic ID。
  • 列出所有功能:$SKILL_DIR/scripts/list-features.sh,返回业务索引中的功能注册表。
  • 追踪代码位置:$SKILL_DIR/scripts/trace-code.sh ARCH-L1,返回实现位置对应的精确 file:line:function。

文档结构

docs/semantic/ 目录的组织方式如下:

  • 00_BUSINESS_INDEX.md:主索引,建议先阅读以获得概览。
  • tech/*.md:按功能划分的技术规格。
  • schemas/*.base-fields.json:基础字段模式,由 PHP 的 baseFieldDefinitions() 自动生成。
  • schemas/*.BUNDLE.json:配置字段模式,由 YAML(field.storage..yml 与 field.field..yml)自动生成。
  • schemas/*.business.json:业务模式,由 AI 撰写,包含规则、关联实体和示例,不含字段定义。
  • SUMMARY.md:快速参考(如存在)。

Logic ID 规则

每份技术规格都含有 Logic ID,用于把业务逻辑映射到代码。引用实现时应使用 Logic ID,而不是猜测文件路径。格式为 FEATURE-L#:FEATURE 为 3–4 个字母的功能代码,L 表示 Logic,

为顺序编号,例如 AUTH-L1、ACCS-L3、MIGR-L10。

常见 Drupal 功能代码包括:AUTH(认证与登录)、ACCS(访问控制)、CONT(内容类型)、MIGR(迁移)、VIEW(视图与展示)、FORM(表单与验证)、BLOC(区块与区域)、CACH(缓存)、THEM(主题)、HOOK(钩子实现)、SERV(服务)、PLUG(插件)、ROUT(路由)、CONF(配置)。

触发场景

该技能适用于以下问题:“某业务规则在哪里实现?”“某 Logic ID 做什么?”“展示某功能的技术规格”“某实体有哪些字段?”“某工作流如何执行?”“哪个代码处理某用户故事?”“列出所有功能”“查找某模块的代码位置”。

手动搜索

如果脚本未能找到所需内容,可以手动搜索:

  • 搜索业务索引:grep -i "keyword" docs/semantic/00_BUSINESS_INDEX.md
  • 搜索全部技术文档:grep -r "keyword" docs/semantic/tech/
  • 列出可用功能:ls docs/semantic/tech/*.md | sed 's/.*\///' | sed 's/_.*$//' | sort -u
  • 列出可用模式:ls docs/semantic/schemas/*.json | sed 's/.*\///' | sed 's/\.json$//'

更复杂的 grep 查询和实体模式细节可参考 SEARCH.md 与 ENTITY-LOOKUP.md。

适用场景与限制

该技能面向使用 Drupal 并维护语义化业务文档的项目,依赖 docs/semantic/ 目录结构及配套脚本存在。关于脚本的具体实现、依赖环境、安装方式和兼容性,资料暂未提供。