返回项目列表
AI / ML活跃

AI项目上下文技能

一个面向 Claude Code 的项目上下文注入工具，旨在减少 AI 辅助开发中的重复性解释工作。

TypeScriptMarkdownAgent Skills
GitHub

概述

AI 项目上下文技能是一个面向 AI 辅助编程场景的工具，旨在 AI 助手的会话语境与开发者项目结构之间建立桥梁。通过对项目的目录结构、依赖配置与关键文件进行分析，生成可供 AI 助手理解的上下文摘要，从而提升辅助响应的准确性与相关性。

项目的分层设计理念参考了 @obra(opens in a new tab) 的 Superpowers(opens in a new tab) 工作流框架。

核心内容

技能本身以 SKILL.md 定义了一套完整的上下文管理规范，主要包括：

  • 分层文档模型：定义 A–D 四个层级，从索引到架构决策，明确各层职责与边界
  • 变更类型矩阵：按变更类型（跨模块依赖、公开 API、数据模型等）指定应触发的文档层级
  • SSOT 优先级规则：源码 > 自动化测试 > Markdown，冲突时优先信任代码
  • 文档生命周期：创建 / 更新 / 废弃 / 归档的标准流程

分层策略

层级角色内容
A — 索引单入口，仅链接项目地图、阅读顺序、关键路径
B — 系统形态结构快照技术栈、目录拓扑、依赖关系
C — 契约外部状态锚点数据模型、API 接口（链接到 schema）
D — 决策ADR 记录架构决策及其理由

SSOT（单一可信来源）

避免多源信息冲突：源码和自动生成的制品（OpenAPI、protos、类型定义）始终优先，文档仅描述意图和边界，不重复 schema 中的字段。

模板化实践

项目中提供了若干模板文件，可作为项目接入 AI 助手的起点：

  • AI_INDEX.template.md — 项目索引模板
  • ADR.template.md — 架构决策记录模板
  • SSOT_SNIPPET.md — 单一可信来源配置片段

安装与使用

将 skills/ai-project-context/ 目录复制至支持 Agent Skills 规范的 AI 客户端的 skills 目录即可。支持 Claude Code、Cursor 等客户端。

使用方式：

  1. 将模板从 templates/ 复制到项目（如 docs/AI_INDEX.md）
  2. 在 AGENTS.md 或 CLAUDE.md 中添加 SSOT 配置块，设定实际路径
  3. 保持 A 层（索引）精简，指向 schema 而非复制字段
  4. 按变更类型矩阵判断何时更新对应层级的文档

参考