docs: 更新文档内容并修正格式

README.md

@@ -1,10 +1,8 @@
 # ExamAware 文档
 
-这是 [ExamAware](https://github.com/ExamAware/ExamAware-docs) 文档仓库。本文档基于 [VuePress](https://vuejs.press/) 搭建
+这是 [ExamAware 文档](https://github.com/ExamAware/ExamAware-docs) 仓库。本文档基于 [VuePress](https://vuejs.press/) 搭建，[在线查看文档](https://examaware.gdata.fun)。
 
-[在线查看文档](https://examaware.gdata.fun)
+## **开始编写文档**
-
-## 开始编写文档
 
 1. 安装 Node 20 环境（推荐使用NVM）
 2. 克隆并进入文档仓库
@@ -19,7 +17,7 @@
     pnpm run docs:dev
     ```
 
-启动 VuePress 服务器后，在浏览器中打开终端输出的链接（默认是[http://localhost:8080/](http://localhost:8080/)）即可浏览文档。当本地文档做出更改时，浏览器中的文档将自动刷新。
+5. 在浏览器中键入终端输出的链接（默认是[http://localhost:8080](http://localhost:8080)），即可浏览文档。当本地文档做出更改时，浏览器中的文档将自动刷新。
 
 本文档使用了 vuepress-plugin-md-enhance
  的一些扩展语法，请尽量直接编辑 Markdown 文件，而不是使用可视化 Markdown 编辑器。建议使用 [Visual Studio Code](https://code.visualstudio.com/) 编辑文档。

src/.vuepress/theme.ts

@@ -38,7 +38,7 @@ export default hopeTheme({
       sidebar: zhSidebar,
 
       //  autocorrect-disable
-      footer: "Copyright (c) 2024 ExamAware | " +
+      footer: "Copyright (c) 2025 ExamAware | " +
           '本文档以 CC BY-NC-SA 4.0 许可协议授权。',
       //  autocorrect-enable
 

src/README.md

@@ -27,14 +27,14 @@ actions:
 
 欢迎来到 ExamAware 的文档。
 
-ExamAware 系列软件是显示当前时间与考试详细信息的工具，可以在各平台上运行。
+ExamAware 系列可以显示当前时间与考试详细信息，并支持在各平台上运行。
 
 ## 开始使用
 
 <div class="vp-card-container">
   <VPCard
     title="安装与开始"
-    desc="了解 ExamAware 系列的设备需求，以及如何在您的设备上安装 ExamAware。"
+    desc="了解 ExamAware 系列的系统需求，以及如何在您的设备上安装和使用 ExamAware。"
     link="./app/setup"
   />
 </div>
@@ -47,13 +47,13 @@ ExamAware 系列软件是显示当前时间与考试详细信息的工具，可
 
 <div class="vp-card-container">
   <VPCard
-    title="桌面版应用帮助"
+    title="桌面端应用帮助"
-    desc="了解应用的基本使用方法。"
+    desc="了解桌面端应用的基本使用方法。"
     link="./app/"
   />
   <VPCard
     title="集控和网页版应用帮助"
-    desc="查看这部分文档包含了关于集控的帮助，以及网页版应用部署的教程。"
+    desc="了解集控帮助以及网页版应用部署的教程。"
     link="./management/"
   />
 </div>

src/app/README.md

@@ -6,7 +6,7 @@ category:
   - 使用指南
 ---
 
-这里是 ExamAware 帮助文档，关于应用本体的使用方法和常见问题，请参阅本文档。
+这里是 ExamAware 桌面端应用帮助文档，关于桌面端应用的使用方法和常见问题，请参阅本文档。
 
 ## 安装 ExamAware
 

src/app/profile/faq.md

@@ -1,67 +1,35 @@
-# 配置文件
+# 编写配置文件
 
-此配置文件保存着考试名称, 考试考场, 考试开始/结束时间等信息。
+本应用配置文件记录了考试名称、提示信息、考场号，考试信息（科目名称、开始/结束时间、结束提醒时间）。
 
-您可以手动编写配置文件，也可以直接使用[配置文件编辑器](https://github.com/ExamAware/DSZExamShowBoardEditor/releases/latest)编写配置文件。
+您可以按照模板手动编写配置文件，也可以直接使用[配置文件编辑器（旧版）](https://github.com/ExamAware/DSZExamShowBoardEditor/releases/latest)编写配置文件。
 
-在新版本（即 `ExamAware2` 和 `ExamCloud` ）中，已经集成了编辑器，可以略过本部分帮助。
+在新版本（即 [`ExamAware2`](https://github.com/ExamAware/ExamAware2) 和 [`ExamCloudSchedule`](https://github.com/ExamAware/ExamCloudSchedule) ）中，已经集成了编辑器，可以略过本部分帮助。
-
-## 配置文件编辑器（旧版）
-
- 您可以前往[ExamShowBoardEditor](https://github.com/ProjectCampus-CH/DSZExamShowBoardEditor/releases/latest)获取GUI的配置文件生成软件   
- 1.双击运行从[仓库](https://github.com/ProjectCampus-CH/DSZExamShowBoardEditor/releases/latest)下载的软件   
- 2.点击 `添加考试信息` 按钮添加考试信息   
-  - 输入考试科目名称   
-  - 输入考试日期，考试日期的格式如下
-    - ` YYYY-MM-DD ` 例如 `` 2025-01-01 `` 
-    - ` YYYY/MM/DD ` 例如 `` 2025/01/01 ``
-  - 分别输入考试开始/结束时间，格式为 ` HH:MM:SS ` 例如 `` 08:00:00 ``
-  - 点击 `保存` 按钮保存输入的考试信息   
-
- 3.点击 ` 保存到json ` 按钮保存到配置文件中
-  - 输入考试标题
-  - 输入考试副标题
-  - 输入考场号
-  - 点击 ` 保存 ` 按钮导出配置文件   
-
-> [!tip]
->
-> 点击`保存JSON`按钮后配置文件默认会保存在配置文件编辑器所在目录下`exam_config.json`
->
-> `message` 与 `room` 内容必填（可填空格隐藏），`examInfos` 至少需要一条数据。
->
-> 如果有两个以"/"分隔的科目可以自动转化为双行显示   
-
-4.点击`打开配置文件`按钮可打开并编辑配置文件，您可以在其中编辑考试信息。
-  - 在下方的选择框中使用鼠标选择考试科目
-  - 点击 `编辑选中信息` 按钮添编辑选中的考试科目信息
-  - 点击 `删除` 按钮删除选中的考试科目
-  - 点击 `上移/下移` 按钮移动选中的考试科目(此按钮可以调整考试科目显示的顺序)
 
 ## 手动编写配置文件   
 > [!warning]
 >
-> 请确保 `exam_config.json` 文件编码为 `UTF-8`，换行符为 `LF`，按照`json`文件格式填写。不然可能会出一些神奇的 Bug。
+> 请确保 json 配置文件编码为 `UTF-8`，换行符为 `LF`，按照 `json` 文件格式填写，不然可能会出一些神奇的 Bug 。
 >
-> 不确定？可以使用 [VSCode](https://code.visualstudio.com/) 打开、编辑文件，右下角显示编码格式和换行方式，点击即可更改。
+> 不确定？可以使用 [Visual Studio Code](https://code.visualstudio.com/) 编辑配置文件，支持自动检查和语法高亮，右下角显示编码格式和换行符，点击即可更改。
 
  1. 新建一个名为 `exam_config.json` 的文件
- 2. 编辑文件内容，格式如下
+ 2. 开始编辑文件，对应位置替换为指定内容，模板如下：
  ```json
 {
   "examName": "考试名称",
-  "message": "信息",
+  "message": "提示信息",
   "room": "考场号",
   "examInfos": [
     {
       "name": "科目",
-      "start": "2024-12-01T07:00:00",
+      "start": "2025-01-01T07:00:00",
-      "end": "2024-12-01T08:00:00"
+      "end": "2025-01-01T08:00:00"
     },
     {
       "name": "科目/科目",
-      "start": "2024-12-01T09:00:00",
+      "start": "2025-01-01T09:00:00",
-      "end": "2024-12-01T10:00:00"
+      "end": "2025-01-01T10:00:00"
     }
   ]
 }
@@ -69,10 +37,37 @@
 
 > [!tip]
 >
-> `message` 与 `room` 内容必填（可填空格隐藏），`examInfos` 至少需要一条数据。
+> 考试名称不能为空，`examInfos` 至少需要一条数据（科目名称不能为空，开始时间和结束时间不能为空，且前者必须早于后者，考试结束提醒时间必须是非负整数）。
 >
 > 如果有两个以"/"分隔的科目可以自动转化为双行显示
 
+## 配置文件编辑器（旧版）
+
+ 您可以前往 [ExamShowBoardEditor（已存档·只读）](https://github.com/ExamAware/DSZExamShowBoardEditor/releases/latest) 获取配置文件编辑器   
+ 1. 运行解压出的 `GUI.exe`
+ 2. 点击 `添加考试信息` 按钮添加考试信息   
+  - 输入考试科目名称   
+  - 输入考试日期，格式为 `YYYY-MM-DD` ，例如 `2025-01-01`
+  - 分别输入考试开始/结束时间，格式为 `HH:MM:SS` ，例如 `08:00:00`
+  - 点击 `保存` 按钮保存输入的考试信息
+ 3. 点击 `保存到json` 按钮保存到配置文件中
+  - 输入考试标题
+  - 输入考试副标题
+  - 输入考场号
+  - 点击 `保存` 按钮导出配置文件   
+
 > [!tip]
 >
->您可以将配置文件复制到 U 盘等介质中，然后在另一台电脑上保存该文件，以实现配置文件的转移及部署;您也可以使用[集控]实现配置文件的下发及部署。   
+> 点击 `保存json` 按钮后配置文件默认会保存在配置文件编辑器所在目录下，文件名为 `exam_config.json`
+>
+> `message` 与 `room` 内容必填（可填空格隐藏），`examInfos` 至少需要一条数据。
+
+4.点击 `打开配置文件` 按钮可打开并编辑配置文件
+  - 在下方的选择框中选择考试科目
+  - 点击 `编辑选中信息` 按钮编辑选中的考试科目信息
+  - 点击 `删除` 按钮删除选中的考试科目信息
+  - 点击 `上移/下移` 按钮移动选中的考试科目信息(以调整考试科目显示的顺序)
+
+> [!tip]   
+>
+>您可以将配置文件复制到 `U盘` 等存储介质中，以实现配置文件的转移及部署；您也可以使用[集控]以实现配置文件的分发及部署。   

src/app/setup.md

@@ -9,64 +9,60 @@ tag:
 
 # 安装与开始
 
-本文将介绍如何安装与开始使用考试看板。 
+本页将介绍如何安装考试看板桌面端与开始使用。 
 
 ## 检查系统需求
 
-首先，确保您的设备满足以下需求：   
+首先，确保您的设备系统满足以下需求：
- - Windows 10 及以上版本的系统，x86_64 架构   
+- 桌面端
- -  Linux 系统
+  - Windows 系统
- -  macOS 系统
+    - Windows 10 及以上版本，x86_64 架构   
-    -  macOS 13 及以上版本
+  - Linux 系统
- -  移动设备
+  - macOS 系统
-    - 安卓系统
+    - macOS 13 及以上版本
-      - 安卓 7 及以上版本
+- 移动端
-    - iOS 系统
+  - 安卓系统
-      - iOS 13 及以上版本
+    - 安卓 7 及以上版本
+  - iOS 系统
+    - iOS 13 及以上版本
 
-# 下载应用本体
+# 下载安装程序
 
-对于普通用户，可以在以下渠道下载到本软件，请根据自身网络环境选择合适的渠道。
+| | 🚀 发行版<br/>[![GitHub Release](https://img.shields.io/github/v/release/ExamAware/dsz-exam-showboard?include_prereleases&style=flat-square&logo=GitHub&label=最新版本)](https://github.com/ExamAware/dsz-exam-showboard/releases/) | 🚧 当前构建 |
-| Github下载 | [Releases](https://github.com/ExamAware/dsz-exam-showboard/releases) | [Actions](https://github.com/ExamAware/dsz-exam-showboard/actions) |
 | ---- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | 
+| Github 下载 | [Releases](https://github.com/ExamAware/dsz-exam-showboard/releases) | [Actions](https://github.com/ExamAware/dsz-exam-showboard/actions) |
 
 # 安装软件
 
-下载完成后，双击运行对应版本的安装包，等待进度条走完后双击运行系统桌面的 `ExamShowboard`快捷方式即可开始使用   
+下载完成后，运行安装程序，等待进度条走完后双击自动创建的 `ExamShowboard` 桌面快捷方式即可进入应用   
 
-> [!tip]
+# 遇到问题
-> 本软件的默认安装路径为 `AppData\Local\Programs\exam-showboard`   
->   
 
-# 遇到问题？
+如果安装时遇到问题，**首先请自行[百度](https://www.baidu.com/)一下**。如果问题无法解决，您可以在 [`QQ 群｜901670561`](https://qm.qq.com/q/zDiEipHsaI) 求助或者前往 [Discussion](https://github.com/orgs/ExamAware/discussions)讨论。
-
-如果安装时遇到问题，**首先请自行[百度](https://www.baidu.com/)一下**。如果问题无法解决，您可以[在 QQ 群求助](https://qm.qq.com/q/zDiEipHsaI)或者[前往 Discussion](https://github.com/orgs/ExamAware/discussions)。
 
 # 开始使用
 
 如果您要进一步了解本软件，您可以继续阅读本文档。
 
-::: details 在 Windows 7 中安装 ExamAware
+::: details 在 Windows 7 中安装 ExamAware（点击展开）
 
 > [!caution]
-> **在 Windows 7 中使用 ExamAware 是不现实的。** 受限制于框架问题，在 Windows 7 中，您无法打开 ExamAware 。
+> **在 Windows 7 中使用 ExamAware 是不现实的。** 受限制于框架问题，您无法在 Windows 7 中运行 ExamAware 。
 
 此外，**微软对 Windows 7 的支持已经在 2020/1/14 终止** [^1]。如果您汇报在 Windows 7 中遇到系统相关问题， **开发者可能不会受理。**
 
 :::
 
-## 下载应用本体
+## 其它平台
 
-对于普通用户，可以在以下渠道下载到本软件，请根据自身网络环境选择合适的渠道。
+| 平台 | 🚀 发行版 | 🚧 当前构建 |
-
-::: warning
-当前构建包含最新的功能，但也可能包含未完善和不稳定的功能，请谨慎使用。
-
-| 平台 | **🚀 正式版**<br/>[![GitHub Release](https://img.shields.io/github/v/release/ExamAware/dsz-exam-showboard?include_prereleases&style=flat-square&logo=GitHub&label=最新版本)](https://github.com/ExamAware/dsz-exam-showboard/releases/) | 🚧 当前构建 |
 | - | - | - |
-| 桌面端 | [dsz-exam-showboard/releases](https://github.com/ExamAware/dsz-exam-showboard/releases) | [dsz-exam-showboard/actions](https://github.com/ExamAware/dsz-exam-showboard/actions) |
 | 移动端 | [dsz-examaware-mobile/releases](https://github.com/ExamAware/dsz-examaware-mobile/releases) | [dsz-examaware-mobile/actions](https://github.com/ExamAware/dsz-examaware-mobile/actions) |
+| 网页端 | [ExamSchedule-main](https://github.com/ExamAware/ExamSchedule) | [ExamSchedule-dev](https://github.com/ExamAware/ExamSchedule/tree/dev) |
 
-:::
+> [!warning]
+>
+> 当前构建包含最新的功能，但也可能包含未完善和不稳定的功能，请谨慎使用。
 
-[^1]: Windows 7 生命周期策略：<https://learn.microsoft.com/zh-cn/lifecycle/products/windows-7>。Windows 7 ESU 结束支持于 2023/1/10。
+___
+Windows 7 生命周期策略：<https://learn.microsoft.com/zh-cn/lifecycle/products/windows-7>。Windows 7 ESU 结束支持于 2023/1/10。