77 lines
3.3 KiB
Markdown
77 lines
3.3 KiB
Markdown
---
|
||
name: lyxy-kb
|
||
description: 基于文件的个人知识库管理 skill。当用户说"创建知识库"、"初始化知识项目"、"入库文档"、"知识问答"、"基于文档回答"时使用。支持文档解析入库、增量摘要、渐进式问答。配合 /lyxy-kb-init、/lyxy-kb-ingest、/lyxy-kb-ask 等 command 使用。
|
||
compatibility: 依赖 lyxy-reader-office skill 解析 office 文档（.docx/.pdf/.pptx/.xlsx），依赖 lyxy-runner-python skill 执行 Python 脚本。
|
||
---
|
||
|
||
# 个人知识库 Skill
|
||
|
||
基于文件的个人知识库管理系统。将项目相关文档组织为可被大模型高效检索和问答的知识库，支持文档解析入库、增量摘要、渐进式问答。
|
||
|
||
## Purpose
|
||
|
||
**纯文件驱动**：不依赖数据库或向量存储，所有数据以文件形式存在于项目目录中。
|
||
|
||
**渐进式查询**：通过 project.md 摘要索引 + parsed 详细文件的分层结构，优先读取摘要，按需加载详细内容，节省 token 消耗。
|
||
|
||
**增量管理**：支持增量解析入库和增量更新摘要，避免重复处理已入库的文档。
|
||
|
||
## When to Use
|
||
|
||
任何需要基于一组项目文档进行知识管理和问答的场景。
|
||
|
||
### 典型场景
|
||
- **项目文档管理**：将需求文档、技术方案、数据表等组织为结构化知识库
|
||
- **文档解析入库**：将 office 文档和纯文本文件解析为 markdown 并生成摘要
|
||
- **知识问答**：基于已入库的文档回答问题，并标注信息来源
|
||
|
||
### 不适用场景
|
||
- 需要语义搜索或向量化检索
|
||
- 需要跨多个知识项目关联查询
|
||
- 需要多人协作或权限控制
|
||
|
||
## Quick Reference
|
||
|
||
| Command | 触发方式 | 说明 |
|
||
|---------|----------|------|
|
||
| init | `/lyxy-kb-init <name>` | 初始化知识项目目录结构 |
|
||
| ingest | `/lyxy-kb-ingest <name>` | 解析 sources/ 中新文件，增量更新 project.md |
|
||
| rebuild | `/lyxy-kb-rebuild <name>` | 全量重新生成 project.md |
|
||
| ask | `/lyxy-kb-ask <name>` | 基于知识库进行会话问答 |
|
||
|
||
## Workflow
|
||
|
||
### 知识项目目录结构
|
||
|
||
```
|
||
<project-name>/
|
||
├── project.md # 高度摘要 + 文件索引
|
||
├── manifest.json # 增量追踪
|
||
├── parsed/ # 解析后的 markdown
|
||
├── sources/ # 待处理区（用户放入原始文档）
|
||
└── archive/ # 原始文件备份（带时间戳）
|
||
```
|
||
|
||
### 基本工作流程
|
||
|
||
1. **初始化**：使用 `/lyxy-kb-init <name>` 创建项目目录结构
|
||
2. **入库**：将文档放入 `sources/`，执行 `/lyxy-kb-ingest <name>`
|
||
3. **问答**：使用 `/lyxy-kb-ask <name>` 基于知识库回答问题
|
||
|
||
### 渐进式查询策略
|
||
|
||
1. **读取 project.md**：获取项目概述和文件索引（低 token 开销）
|
||
2. **判断相关文件**：根据用户问题和摘要判断需要查阅哪些 parsed 文件
|
||
3. **按需加载**：读取相关 parsed 文件的全部或部分内容
|
||
4. **回答并标注来源**：基于获取的信息回答问题
|
||
|
||
## References
|
||
|
||
详细文档请参阅 `references/` 目录：
|
||
|
||
| 文件 | 内容 |
|
||
|------|------|
|
||
| `references/structure.md` | 目录结构规范、project.md 格式、manifest.json 结构、parsed 元信息标记 |
|
||
| `references/workflow.md` | 文档生命周期、归档命名规则、冲突检测、解析策略 |
|
||
| `references/query-strategy.md` | 渐进式查询策略、来源引用格式、依赖关系、限制说明 |
|