SuperAPI AI 工具集

lat-md

通用与其它

查看项目

更新于 10-16 05:53

技能介绍

用途:lat.md 文件描述项目做什么与为什么,包括领域概念、关键设计决策、业务逻辑与测试规范,不重复源代码。每个章节像锚点,供源代码反向引用。适合写入的内容有架构决策及理由、领域概念与业务规则、API 契约与协议、测试规范(测什么与为什么)、不易察觉的约束或不变量;不适合代码逐步讲解、自动生成的 API 文档、临时笔记或 TODO。

结构规则:每个章节标题后必须紧跟至少一段导语,且第一段不超过 250 字符(不含 [[wiki 链接]] 内容),该段是章节身份,会出现在搜索结果、命令输出和 RAG 上下文中;缺少导语会被 lat check 判定无效。

章节 ID:由文件路径与标题链组成,完整形式为 lat.md/path/to/file#Heading#SubHeading,文件名词干唯一时可用短形式 file#Heading#SubHeading。

Wiki 链接:用 [[target]] 或 [[target|alias]] 交叉引用章节或源代码符号,例如 [[cli#init]]、[[src/config.ts#getConfigDir]]、[[src/server.ts#App#listen]],lat check 会校验目标是否存在。

代码引用:在源码中用 @lat: 注释回指章节,如 // @lat: [[cli#init]] 或 # @lat: [[cli#init]],支持 // 与 # 注释风格;每章节一个注释,放在相关代码处而非文件顶部。

测试规范:在 lat.md 中以章节描述测试,并通过 YAML frontmatter 开启 require-code-mention: true 要求每个叶子章节都有对应的 @lat: 注释;每个叶子章节必须被恰好一个 @lat: 注释引用,且必须有至少一句说明测什么与为什么。

校验:编辑后应运行 lat check,校验 wiki 链接指向存在的章节或源码符号、@lat: 引用指向存在的章节、每个章节有不超过 250 字符的导语、require-code-mention 叶子章节均被代码引用。当前 frontmatter 仅支持 require-code-mention 字段。具体安装与调用方式资料暂未提供。