arrow_backRetour aux issues
qemu-camp/qemu-camp-tutorial
#124
Débutant
Ouvrirarrow_forward
Débutant
Ouvrirarrow_forward
Débutant
Ouvrirarrow_forward
【讲义校验】持续检查 2026 QEMU Camp Tutorial 的讲解清晰度
ecoDébutant
documentation
help wanted
descriptionDescription
## 背景
希望把本 Issue 作为 QEMU Camp Tutorial 讲义的持续校验清单,集中检查内容是否**清晰、准确、完整且可复现**。参与者可以先在本 Issue 下发表评论提交审阅结果;对于确认需要修改的内容,再通过 PR 提交修订。
本 Issue 面向新读者和实际跟随教程操作的读者,重点关注“读者能否理解并完成操作”,而不只是 Markdown 或错别字检查。
## 检查范围
- [ ] 教程总索引:`docs/tutorial/index.md`
- [ ] 2026 年报名/说明页:`docs/tutorial/2026/index.md`、`docs/tutorial/2026/enroll.md`
- [ ] 第 0 章:`docs/tutorial/2026/ch0/**`
- [ ] 第 1 章:`docs/tutorial/2026/ch1/**`
- [ ] 第 2 章:`docs/tutorial/2026/ch2/**`
- [ ] 第 3 章:`docs/tutorial/2026/ch3/**`(包括配套演示文稿)
如发现某个章节过大,可以在评论中认领具体目录或文件,避免重复检查。
## 检查维度
- **目标与前置条件**:读者是否知道本节要解决什么问题、需要哪些知识/软件/硬件。
- **结构与表达**:标题层级、叙述顺序、术语和缩写是否清楚,是否存在跳步或歧义。
- **技术准确性**:QEMU 原理、命令、代码、配置、版本信息和链接是否正确、是否过时。
- **可操作性**:命令和代码是否可以直接复制执行,输入/输出、预期结果和失败排查是否说明。
- **图表与示例**:图片、代码块、示例是否与正文对应,图片替代文本和说明是否足够。
- **一致性与可访问性**:章节之间的命名、路径、版本、格式和术语是否一致,页面渲染和链接是否正常。
## 评论反馈模板
请尽量一条评论对应一个明确问题,并使用以下格式:
```
### [S1] 简短问题标题
- 文件/章节:
- 定位:标题、段落、代码块或链接
- 现象:
- 对读者的影响:
- 建议修改:
- 是否愿意提交 PR:是/否
```
严重程度建议:
- **S0**:阻断阅读或会导致数据损坏/严重错误
- **S1**:核心概念错误、关键步骤无法执行或会误导读者
- **S2**:影响理解或复现,但有替代路径
- **S3**:措辞、排版、链接或其他轻微改进
如果只是确认某章节清晰,也欢迎评论报告检查结论,例如“已检查 `path/to/file.md`,未发现阻塞问题”。
## PR 提交约定
- 一个 PR 尽量只处理一个主题或一组紧密相关的问题。
- PR 描述中使用 `Refs #<本 Issue 编号>` 关联本 Issue;只有在本 Issue 的全部检查项完成后才关闭它。
- 按仓库的 CONTRIBUTING.md 执行格式检查和本地预览:`make format`、必要时执行 `make mdformat` / `make mdlint`,并使用 `make serve` 检查页面渲染、链接和示例。
- PR 描述请列出修改文件、修改类型、验证命令和预览结果。
## 完成标准
- [ ] 所有目标目录均有检查结论,或已明确记录暂不检查的原因。
- [ ] S0/S1 问题已修复并通过 Review;S2/S3 问题已修复、记录为接受,或形成后续 Issue。
- [ ] 相关 PR 已合并,检查清单和评论中的状态已更新。
- [ ] 文档格式检查、构建和本地预览均通过。
欢迎在评论中先认领检查范围、交流判断标准,再提交具体问题或 PR。
Issues similaires
calkit/calkit
star53
Poids du dépôt moyen
VS Code extension should be robust to YAML parser errors
Seeing this error: ``` Failed to read calkit.yaml: YAMLParseError: A block sequence may not be used as an implicit map…
Python
bug
good first issue
fu351/Doberman-Core
star211
Poids du dépôt léger
dash: a manual Refresh control
The dashboard polls: `refreshStats()` (`src/doberman/dash/app.py:408`) every 5 s and `refreshPending()` (`:546`) every …
Python
enhancement
good first issue
fu351/Doberman-Core
star211
Poids du dépôt léger
dash: "Copy details" button on each pending-approval card
Each pending-approval card in the dashboard (`renderPending`, `src/doberman/dash/app.py:448-544`) shows the risk badge,…
Python
enhancement
good first issue