Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

LLM WIKI - 智能项目知识库构建工具

为项目建立持久的知识记忆,告别重复检索,让 LLM 基于结构化 wiki 高效工作。

🎯 解决的痛点

传统方式的问题

  1. 记忆不可见:LLM 对项目的理解存储在临时上下文中,用户无法查看和验证
  2. 重复检索:每次提问或修改代码都需要重新检索整个项目,效率低下
  3. 知识丢失:关闭项目后再次打开,之前的分析成果全部丢失,需要重新检索
  4. Token 浪费:反复检索整个项目导致大量不必要的 token 消耗

LLM WIKI 的解决方案

在项目开始时一次性检索分析,将知识结构化沉淀为持久的 wiki 文档。后续所有交互都基于这个 wiki 进行:

  • 首次分析:建立完整的项目知识图谱
  • 后续请求:LLM 只需读取 wiki,无需重复检索整个项目
  • 增量更新:代码变更时仅同步更新受影响的 wiki 页面
  • 永久保存:知识沉淀为 Markdown 文件,可版本控制、可分享
传统方式:每次请求 → 检索整个项目 → 分析 → 响应 → 知识丢失
LLM WIKI: 首次分析 → 构建 wiki → 后续请求 → 查询 wiki → 响应 → 知识累积

✨ 核心特点

  • 项目记忆:为项目建立持久的知识记忆,避免重复检索
  • 高效推理:LLM 基于 wiki 快速响应,无需每次检索整个项目
  • 📚 知识沉淀:分析结果结构化存储,越积越厚
  • 🔗 智能关联:自动建立模块、概念、版本之间的交叉引用
  • 📊 可视化架构:用 Mermaid 图表直观呈现项目结构
  • 🔄 增量更新:代码变更时仅同步更新受影响的 wiki 页面

🎯 适用场景

场景 示例
项目记忆初始化 "帮我分析整个项目" - 一次性建立完整记忆
模块深度分析 "分析一下用户认证模块" - 深入了解特定模块
增量记忆更新 代码变更后自动同步相关 wiki 页面
知识查询 "项目的认证流程是怎样的?" - 基于记忆快速回答
代码构建 "帮我修改登录模块" - LLM 基于 wiki 进行代码构建
记忆体检 "检查一下 wiki" - 验证记忆完整性

📁 Wiki 目录结构

project/
└── wiki/
    ├── index.md              # 全部页面目录索引
    ├── log.md                # 操作日志记录
    ├── overview/
    │   └── project-overview.md  # 项目概览
    ├── modules/              # 功能模块详细分析
    │   ├── module-a.md
    │   └── module-b.md
    ├── concepts/             # 核心概念与设计模式
    │   ├── concept-a.md
    │   └── concept-b.md
    └── versions/             # 版本变更记录
        └── vX.Y.Z-changelog.md

🔧 使用方式

快速开始

  1. 加载技能:在支持 LLM 技能扩展的 IDE 或平台中加载此技能
  2. 打开项目:在工作区中打开你的项目目录
  3. 初始化知识库:输入指令 帮我分析整个项目,LLM 会自动执行「首次分析协议」,遍历项目结构并创建完整的 wiki 知识库
  4. 开始使用:后续的所有提问、代码修改请求都将基于 wiki 进行

日常交互指令

指令示例 功能说明
帮我分析整个项目 首次分析,建立完整的项目知识图谱
分析一下用户认证模块 深入分析特定模块,更新对应 wiki 页面
项目的认证流程是怎样的? 基于 wiki 快速回答问题,新发现自动写入 wiki
帮我修改登录模块 LLM 基于 wiki 进行代码构建
检查一下 wiki 验证 wiki 完整性,检查交叉引用和过时内容

工作流程

┌─────────────────────────────────────────────────────────────┐
│                    项目初始化                                │
│  输入:"帮我分析整个项目"                                    │
│  执行:探索项目结构 → 识别模块 → 创建 wiki 知识库              │
└─────────────────────────────────────────────────────────────┘
                           ↓
┌─────────────────────────────────────────────────────────────┐
│                    日常交互                                  │
│  提问/修改请求 → 查询 wiki → 回答/构建 → 更新 wiki            │
│                    ↑                                        │
│           代码变更 → 增量更新受影响页面                       │
└─────────────────────────────────────────────────────────────┘

核心工作机制

  1. 首次分析:LLM 遍历项目结构,识别模块和核心概念,生成结构化的 wiki 文档
  2. 增量学习:每次回答问题或修改代码后,新发现的知识自动追加到 wiki
  3. 智能检索:回答问题前自动查询 wiki,避免重复分析
  4. 同步更新:代码变更时自动检测并更新受影响的 wiki 页面

适用平台

此技能可在任何支持 LLM 扩展的开发环境中使用,包括但不限于:

  • Trae IDE
  • VS Code(配合 LLM 插件)
  • JetBrains 系列 IDE
  • 其他支持技能扩展的 AI 编程助手

输出产物

执行后会在项目根目录生成 wiki/ 目录,包含:

  • index.md - 所有页面的目录索引
  • log.md - 操作日志记录
  • overview/project-overview.md - 项目概览
  • modules/*.md - 各功能模块详细分析
  • concepts/*.md - 核心概念与设计模式
  • versions/*.md - 版本变更记录(可选)

📋 交付质量标准

  • ✅ 每个核心模块都有对应的 modules/ 页面
  • ✅ 每个模块页面包含架构图、核心函数表、数据结构
  • ✅ 模块 ↔ 概念 ↔ 版本之间至少有 2 处交叉引用
  • ✅ 每个页面都有 Mermaid 图表
  • index.md 列出所有页面
  • ✅ 核心函数标注文件路径和行号

📄 许可证

MIT License - 详见 LICENSE 文件

🤝 贡献

欢迎提交 Issue 和 Pull Request!


About

为项目建立持久的知识记忆,让 LLM 基于结构化 wiki 高效工作

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors