59 lines
1.4 KiB
Markdown
59 lines
1.4 KiB
Markdown
# 知识库
|
||
|
||
## 目录说明
|
||
|
||
知识库用于存储**已确定的知识**，包括规范、参考、最佳实践。
|
||
|
||
### 核心原则
|
||
|
||
1. **确定性**：只有已确定、已验证的知识才能进入知识库
|
||
2. **可引用**：知识库内容可以被其他文档引用
|
||
3. **可维护**：知识库内容需要定期更新和维护
|
||
|
||
---
|
||
|
||
## 📐 规范
|
||
|
||
**位置**：`规范/`
|
||
**用途**：编码规范、命名规范、架构规范等约束条件
|
||
|
||
### 内容分类
|
||
- `编码规范.md` - 代码编写规范
|
||
- `命名规范.md` - 命名约定
|
||
- `架构规范.md` - 架构约束
|
||
- `API规范.md` - API设计规范
|
||
|
||
---
|
||
|
||
## 📚 参考
|
||
|
||
**位置**：`参考/`
|
||
**用途**：技术参考、API参考、模式参考
|
||
|
||
### 内容分类
|
||
- `技术栈.md` - 使用的技术栈和版本
|
||
- `API参考.md` - 后端API接口参考
|
||
- `组件参考.md` - 前端组件使用参考
|
||
- `模式参考.md` - 设计模式参考
|
||
|
||
---
|
||
|
||
## ✨ 最佳实践
|
||
|
||
**位置**：`最佳实践/`
|
||
**用途**：已验证的最佳实践、经验总结
|
||
|
||
### 内容分类
|
||
- `前端最佳实践.md` - 前端开发最佳实践
|
||
- `后端最佳实践.md` - 后端开发最佳实践
|
||
- `数据库最佳实践.md` - 数据库操作最佳实践
|
||
|
||
---
|
||
|
||
## 🔄 维护规范
|
||
|
||
1. **新增知识**：需要经过验证和确认才能加入
|
||
2. **更新知识**：更新时需要记录变更原因
|
||
3. **废弃知识**：废弃的知识需要标记并说明原因
|
||
|