diff --git a/docs/ask_question.md b/docs/ask_question.md index c81f09e9..a1b5e491 100644 --- a/docs/ask_question.md +++ b/docs/ask_question.md @@ -210,11 +210,10 @@ 在网页论坛上,好的提问方式稍有不同,因为讨论串与特定的信息紧密结合,并且通常在讨论串外就看不到里面的内容,故通过回复提问,而非改变标题是可接受的。不是所有论坛都允许在回复中出现分离的标题,而且这样做了基本上没有人会去看。不过,通过回复提问,这本身就是暧昧的做法,因为它们只会被正在查看该标题的人读到。所以,除非你**只想**在该讨论串当前活跃的人群中提问,不然还是另起炉灶比较好。 -### 使问题容易回复 +### 便于他人回复你的问题 +不要在提问末尾附带“请将回复发送至……”,这种方式大概率得不到答复。如果你觉得设置回复地址很麻烦,社区参与者同样会认为理解你的问题成本很高。若你的邮件客户端不支持该配置,建议更换合适的邮件工具;操作系统不支持则更换适配的系统环境。 -以`请将你的回复发送到……`来结束你的问题多半会使你得不到回答。如果你觉得花几秒钟在邮件客户端设置一下回复地址都麻烦,社区参与者也觉得花几秒钟思考你的问题更麻烦。如果你的邮件程序不支持这样做,[换个好点的](http://linuxmafia.com/faq/Mail/muas.html);如果是操作系统不支持这种邮件程序,也换个好点的。 - -在论坛,要求通过电子邮件回复是非常无礼的,除非你认为回复的信息可能比较敏感(有人会为了某些未知的原因,只让你而不是整个论坛知道答案)。如果你只是想在有人回复讨论串时得到电子邮件提醒,可以要求网页论坛发送给你。几乎所有论坛都支持诸如`追踪此讨论串`、`有回复时发送邮件提醒`等功能。 +在论坛中,直接要求对方通过邮件单独回复是不礼貌的,仅在内容涉及敏感信息、不宜公开讨论时可以这样做。如果只是希望收到回复提醒,直接使用论坛自带功能即可,绝大多数论坛都提供“追踪讨论串”“回复邮件通知”这类选项。 ### 使用清晰、正确、精准且合乎语法的语句 diff --git a/docs/codespace.md b/docs/codespace.md index c1153d68..374e8c2d 100644 --- a/docs/codespace.md +++ b/docs/codespace.md @@ -139,24 +139,24 @@ python -m mkdocs serve --dev-addr 0.0.0.0:8000 ## 暂时离开与下次继续 -关闭浏览器标签页并不会立即停止 Codespace,它会继续运行,直到空闲超时。结束本次编辑时,先保存文件,并把需要上传的修改提交、同步到个人仓库,再到 [Codespaces 列表](https://github.com/codespaces),找到对应环境,点击 `… → Stop codespace`。确认状态变为已停止后再离开。 +关闭浏览器标签页并不会立即停止 Codespace,它会持续运行直到空闲超时。结束编辑时,请先保存文件,将改动提交并推送到个人仓库,再进入 [Codespaces 列表](https://github.com/codespaces),找到对应环境,点击 `… → Stop codespace`,确认状态变为已停止再离开。 -下次继续时,在同一列表中打开原来的 Codespace,即可恢复已保存的文件;之前运行的预览服务等进程需要重新启动。停止环境不会把尚未推送的提交上传到 GitHub,提交后仍应在仓库页面检查记录。 +> ⚠️ 停止不会自动推送代码。 -停止后不再产生该环境的计算用量,但保存环境仍会占用存储额度。只打算暂时离开时选择停止,长期不用时可在确认所需内容已推送或备份后再决定是否删除。 - -操作说明见 [GitHub:停止和启动 Codespace](https://docs.github.com/zh/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace)。 +下次继续时,在列表打开原有 Codespace,已保存文件可以恢复;之前运行的预览服务等进程需要重新启动。 +停止后不再消耗算力,但依旧占用存储额度;长期不用,确认代码已备份推送后,可以删除环境释放空间。 -## 继续编辑时的检查 +操作说明见 [GitHub:停止和启动 Codespace](https://docs.github.com/zh/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace)。 -重新进入 Codespace 后,在终端依次检查: -- 运行 `git branch --show-current`,确认分支与原 Pull Request 的来源分支一致。 -- 运行 `git status --short`,查看已修改、已暂存和未跟踪的文件,确认列表里都是本次需要处理的内容。 -- 运行 `git diff` 查看尚未暂存的修改,再运行 `git diff --cached` 查看已暂存的修改。两处都核对后,再继续编辑、提交和推送。 +## 重进 Codespace 后的检查步骤 +重新进入 Codespace 后,在终端依次执行检查: +- 执行 `git branch --show-current`,确认当前分支和 PR 来源分支一致。 +- 执行 `git status --short`,核对变更文件列表,确认均为本次待处理内容。 +- 执行 `git diff` 查看未暂存修改;再执行 `git diff --cached` 查看已暂存修改。两处核对无误后,再进行编辑、提交与推送。 -如果分支或文件列表与预期不符,先弄清已有修改的用途,保存好需要保留的内容,再继续操作。 +若分支、变更文件和预期不一致,先梳理现有修改,妥善留存需要保留的内容,再继续操作。 ## 离开前的检查 diff --git a/docs/paper_tips.md b/docs/paper_tips.md index 2f8660e9..149fb911 100644 --- a/docs/paper_tips.md +++ b/docs/paper_tips.md @@ -24,11 +24,10 @@ * [将图形的部分栅格化](#将图形的部分栅格化) * [有用的资源](#有用的资源) -# 排版你的论文 +# 论文排版 +排版是对文字、字母、符号进行版式编排的过程。排版的价值不止于美观,规范清爽的版式可以提升可读性、改善阅读体验,帮助读者更好理解文章内容。 -排版是通过排列字体(例如字母和符号)来编写文本的过程。这主要关乎美观,但精美的字体设计能让文档更易于阅读,更赏心悦目,帮助读者更好地理解信息。 - -我们列出了一些排版技巧和工具,可以更好帮助您撰写文档。其中一些技巧仅适用于 LaTeX,但其他技巧则适用于任何语言。 +本文整理了一系列排版技巧与工具,助力文档创作。其中部分技巧仅适用于 LaTeX,其余方法可通用,适配各类排版工具。 ## 每行一个句子 diff --git a/docs/undergraduate.md b/docs/undergraduate.md index 4d6d2e5e..1a5cc343 100644 --- a/docs/undergraduate.md +++ b/docs/undergraduate.md @@ -6,14 +6,14 @@ 1. 需求分析 2. 系统设计 -3. 编码和实现 +3. 编码与实现 4. 系统测试 -5. 系统部署和维护 +5. 系统部署与维护 -其他要点: +补充要点: +- 数据库:必须包含数据库设计相关内容 +- 测试:覆盖单元测试、集成测试、功能测试、性能测试、压力测试 -- 数据库:需要包含数据库设计 -- 测试:单元测试、集成测试、功能测试、性能测试、压力测试 ## 算法类要求(做算法的)