init: 初始化项目文档中心

- 添加前端设计文档(rui-admin、收银系统、模块打包)
- 添加前端实施计划(收银后台功能完善)
- 添加通用规范(API、编码、数据库、前端开发规则)
- 建立文档索引和使用指南
This commit is contained in:
2026-06-04 08:47:08 +08:00
commit d0771597a6
9 changed files with 5310 additions and 0 deletions
+94
View File
@@ -0,0 +1,94 @@
# Rui-Docs
> 睿核科技项目文档中心 —— 前后端共享的独立文档仓库
## 📁 目录结构
```
rui-docs/
├── README.md # 本文档
├── standards/ # 通用规范(前后端共享)
│ ├── API设计规范.md
│ ├── 前端开发规则.md
│ ├── 数据库设计规范分析.md
│ └── coding-standards.md
├── backend/ # 后端相关文档
│ ├── design/ # 设计文档
│ └── specs/ # 规格说明
└── frontend/ # 前端相关文档
├── design/ # 设计文档
├── specs/ # 规格说明
└── plans/ # 实施计划
```
## 🔗 使用方式
### 作为 Git Submodule
在代码仓库中添加文档子模块:
```bash
# 添加 submodule
git submodule add ssh://git@git.dev.vifo.cc:222/rui/rui-docs.git docs
# 更新到最新
git submodule update --remote
# 初始化(新克隆时)
git submodule update --init --recursive
```
### 独立查看
```bash
git clone ssh://git@git.dev.vifo.cc:222/rui/rui-docs.git
cd rui-docs
```
## 📋 文档索引
### 前端设计文档(frontend/design/
| 文档 | 说明 | 更新日期 |
|------|------|----------|
| `rui-admin功能设计文档.md` | rui-admin 管理后台功能模块设计 | 2026-06-03 |
| `cashier-design.md` | 收银系统(POS)整体架构设计 | 2026-06-03 |
| `admin-ui-module-build-design.md` | Admin-UI 分模块打包功能设计 | 2026-06-04 |
### 前端实施计划(frontend/plans/
| 文档 | 说明 | 更新日期 |
|------|------|----------|
| `cashier-admin-implementation.md` | 收银系统后台管理功能完善实施计划 | 2026-06-04 |
### 通用规范(standards/
| 文档 | 说明 |
|------|------|
| `API设计规范.md` | RESTful API 设计规范 |
| `前端开发规则.md` | 前端编码规范、目录结构、命名约定 |
| `数据库设计规范分析.md` | 数据库设计规范与约束 |
| `coding-standards.md` | 通用编码规范(Java/TypeScript |
## 🔄 文档维护规范
1. **文档即代码**:所有文档使用 Markdown 格式,纳入版本控制
2. **单一数据源**:本文档仓库是唯一的文档源头,代码仓库通过 submodule 引用
3. **变更追溯**:文档修改需通过 PR/MR 流程,保留修改历史
4. **定期同步**:代码仓库的 submodule 应定期更新到最新文档版本
## 📝 新增文档流程
1. 在本文档仓库的对应目录下创建 `.md` 文件
2. 提交并推送到远程
3. 在代码仓库中执行 `git submodule update --remote` 获取更新
## 👥 参与人员
- **前端开发**:关注 `frontend/` 目录
- **后端开发**:关注 `backend/` 目录
- **架构师/全栈**:关注 `standards/` 目录
---
> 📧 文档问题请联系项目维护者