34 lines
2.0 KiB
Markdown
34 lines
2.0 KiB
Markdown
# 星课表文档
|
||
|
||
本文档按 **当前代码** 编写,描述星课表(starschedule)的需求、使用方式与实现。不要把已删除的拾光能力(多学校仓库、iOS、系统日历同步等)当成现网功能。
|
||
|
||
当前版本:`1.0.0`(versionCode `1`)。
|
||
应用包名:`com.starschedule`。
|
||
Kotlin 包名:`com.xingheyuzhuan.shiguangschedule`。
|
||
界面语言:仅简体中文。
|
||
|
||
## 读哪一份
|
||
|
||
| 文档 | 读者 | 内容 |
|
||
|---|---|---|
|
||
| [需求文档](需求文档.md) | 产品、开发、测试 | 目标、范围、功能与非功能需求、验收 |
|
||
| [用户使用说明](用户使用说明.md) | 最终用户 | 各功能操作步骤 |
|
||
| [常见问题](常见问题.md) | 用户、测试 | 导入失败、提醒不响、小组件不刷新等 |
|
||
| [隐私与数据](隐私与数据.md) | 用户、发布 | 权限、本地存储、网络去向 |
|
||
| [架构设计](架构设计.md) | 开发 | 模块划分、分层、关键流程 |
|
||
| [开发文档](开发文档.md) | 开发 | 环境、目录、约定与扩展方式 |
|
||
| [页面与导航](页面与导航.md) | 开发 | Destination、页面、入口路径 |
|
||
| [数据模型](数据模型.md) | 开发 | Room / DataStore / JSON / 备份协议 |
|
||
| [正方教务导入](正方教务导入.md) | 开发 | WebView、JS Bridge、正方脚本 |
|
||
| [构建与发布](构建与发布.md) | 开发、发布 | Gradle、镜像、打包、版本 |
|
||
| [术语表](术语表.md) | 所有人 | 课表领域与工程用语 |
|
||
| [变更记录](变更记录.md) | 所有人 | 版本说明 |
|
||
|
||
## 快速对照
|
||
|
||
- 改界面文案:`shared/src/commonMain/composeResources/values/strings.xml`
|
||
- 改正方抓取:`shared/src/commonMain/composeResources/files/zhengfang.js`
|
||
- 改课表存储:`shared/.../data/db/main/`,升 `MainAppDatabase` 版本
|
||
- 改全局设置:`AppSettingsModel` + `AppSettingsRepository`
|
||
- 打 Debug 包:在仓库根目录执行 `gradlew.bat :app:assembleDebug`(模块名是 `:app`,不是 `:androidApp`)
|