SuperAPI AI 工具集

create-graph-spec

通用与其它

查看项目

更新于 10-15 17:29

技能介绍

用途:把产品或工程意图转化为有效的 graphspec 规格包,即一组由类型化关系交叉链接的 OKF Markdown 概念,且能干净通过 npx graph-spec-cli validate --strict。graphspec 词汇表是封闭的(13 种节点类型、16 种类型化关系),编写意味着把意图映射到该词汇表,而不是扩展它。

调用方式:始终以 npx graph-spec-cli … 调用 CLI,这是 npm 包名,无需预先安装。已安装的二进制名为 graphspec,因此在包已安装或在 PATH 中时,graphspec … 也可用。

工作流:1)建立或定位规格包根目录(根目录含顶层 index.md;index.md 与 log.md 是 OKF 保留文件,不是概念,无需类型 frontmatter,仅有可选的 okf_version);2)从 13 种类型中选择节点类型(Product 层:UserPersona、UserJourney、Feature;Architecture 层:System、Component、Integration、Contract、DataModel;Specification 层:Requirement、Constraint、Decision、TestScenario;Glossary 层:Term);3)编写每个概念文件(文件名为 <name>.<type-token>.md,kebab-case;frontmatter 含 type 及该类型必需字段,如 Integration 的 direction、Requirement/Decision 的 status、Constraint 的 category、TestScenario 的 level,以及推荐的 title、description、tags;正文使用该类型的约定 H1 段落);4)在 frontmatter 的 relations: 下声明类型化边,只能用词汇表中允许的关系名/源类型/目标类型组合;正文中的散文链接仅供人阅读,图查询只遍历 frontmatter relations;允许指向尚不存在的概念(引用优先设计,未解析目标是警告而非阻塞);5)迭代校验,先修 OKF 硬错误,再处理 profile 警告,npx graph-spec-cli validate <path>、--json 查看结构化诊断,最终必须 npx graph-spec-cli validate <path> --strict 退出码为 0;6)npx graph-spec-cli index <path> --log "<what you added>" 重新生成索引,可先 --dry-run 预览或用 --no-index 只追加日志;7)用 npx graph-spec-cli query <path> --type Requirement(可加 --json)做查询核对。

参考:references/profile.md 有完整节点类型表与关系表。该技能目录中的 EXAMPLE.md 是逐命令实录。

限制:词汇表封闭,不得发明新类型或新关系名;不要制造意图未要求的人物画像、旅程或决策;--strict 下除未解析关系目标仍为警告外,其余 profile 警告提升为错误。其他信息暂未提供。