docs: add project handover handbook
Co-authored-by: multica-agent <github@multica.ai>
This commit is contained in:
@@ -0,0 +1,31 @@
|
||||
# 项目需求
|
||||
|
||||
## 项目是什么
|
||||
|
||||
“畅联”是集团内部使用的通讯 App,也就是给员工聊天、找同事和语音通话的工具。项目以开源 OpenIM 为基础改造,保留 OpenIM 原有标识,不换品牌、不另起一套产品标识。
|
||||
|
||||
## 要解决什么
|
||||
|
||||
员工需要在公司内部使用同一个账号,在手机和电脑上沟通,不依赖个人社交软件。管理员可以把员工名单一次导入,员工用工号和密码登录。
|
||||
|
||||
## 必须具备的功能
|
||||
|
||||
1. 聊天:能收发工作消息;当前代码还包含图片、文件和语音消息的相关能力。
|
||||
2. 通讯录:能查找同事、添加同事和管理联系人。
|
||||
3. 一对一语音通话:通过 LiveKit(负责实时语音连接的服务)建立通话。
|
||||
4. 账号登录:员工用“工号 + 密码”登录,不能用个人注册替代。
|
||||
5. 管理员导入:管理员能导入员工名单并管理账号。
|
||||
|
||||
## 支持范围
|
||||
|
||||
- 手机端:Android 和 iPhone 工程都在仓库中;当前手机端版本号为 `1.0.6+7`。
|
||||
- 电脑端:Windows 优先;当前电脑端显示版本为 `v1.0.2`。
|
||||
- 服务端:以 Docker Compose(把一组服务一起启动的工具)编排 OpenIM、账号服务和语音服务。
|
||||
|
||||
## 当前边界
|
||||
|
||||
- 只做集团内部通讯,不改造成公开社交产品。
|
||||
- 保留 OpenIM 的现有标识,禁止替换品牌。
|
||||
- 本项目当前只记录和维护内网环境;公网接入尚未获准施工。
|
||||
- 不把员工名单、密码、管理员口令、密钥或服务器私密配置写入仓库和文档。
|
||||
- 本仓库的日常任务如无明确授权,不做发布、部署或改动生产环境。
|
||||
Reference in New Issue
Block a user