docs: add requirements document (Phase 1)
- 添加需求文档 docs/01-requirements.md - 更新 README.md - Phase 1: 需求评审 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -1,3 +1,74 @@
|
||||
# sanguo_llmwiki
|
||||
|
||||
混合架构 Wiki 系统 - MCP Server + Wiki Skills
|
||||
混合架构 Wiki 系统,将高频查询和维护功能 MCP 化,保留一次性操作为 Skill。
|
||||
|
||||
## 状态
|
||||
|
||||
🚧 开发中 - Phase 1: 需求评审
|
||||
|
||||
## 项目概述
|
||||
|
||||
sanguo_llmwiki 是一个完整的知识管理系统,包含:
|
||||
- **Wiki MCP Server** - 高性能查询和维护服务(Python)
|
||||
- **Wiki Skills** - 11 个一次性操作 Skills
|
||||
- **SQLite 索引** - 持久化索引缓存系统
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
sanguo_llmwiki/
|
||||
├── docs/ # 文档(需求、设计、API)
|
||||
├── mcp_server/ # MCP Server 实现
|
||||
├── skills/ # Wiki Skills
|
||||
├── tests/ # 测试
|
||||
├── deployment/ # 部署配置
|
||||
└── scripts/ # 脚本
|
||||
```
|
||||
|
||||
## 功能矩阵
|
||||
|
||||
| 类型 | 功能 | 实现方式 |
|
||||
|------|------|----------|
|
||||
| 查询 | wiki_query, memory_bridge | MCP |
|
||||
| 维护 | wiki_status, wiki_lint, daily_update | MCP |
|
||||
| 分析 | cross_linker, tag_taxonomy, wiki_synthesize | MCP |
|
||||
| 操作 | wiki-ingest, wiki-capture, ingest-url | Skill |
|
||||
| 管理 | wiki-setup, wiki-rebuild, wiki-export | Skill |
|
||||
| 研究 | wiki-research, impl-validator | Skill |
|
||||
|
||||
## 快速开始
|
||||
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone http://192.168.2.154:3000/sanguo/sanguo_llmwiki.git
|
||||
|
||||
# 安装依赖
|
||||
cd sanguo_llmwiki
|
||||
pip install -r requirements.txt
|
||||
|
||||
# 启动 MCP Server
|
||||
python -m mcp_server.main
|
||||
```
|
||||
|
||||
## 文档
|
||||
|
||||
- [需求文档](docs/01-requirements.md)
|
||||
- [设计文档](docs/02-design.md) - 待完成
|
||||
|
||||
## 开发流程
|
||||
|
||||
1. 需求 → 评审 → 设计 → 评审 → 编码 → 评审 → 测试 → 评审 → 部署
|
||||
2. 每个阶段由独立的 sub-agent 评审
|
||||
3. 所有成果物提交到 Gitea
|
||||
|
||||
## 许可证
|
||||
|
||||
MIT License
|
||||
|
||||
## 作者
|
||||
|
||||
sanguo team
|
||||
|
||||
---
|
||||
|
||||
*最后更新:2026-06-26*
|
||||
|
||||
Reference in New Issue
Block a user